Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature: Add README file #16

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feature: Add README file #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Map Checking

## Introduction

This is a tool that helps you estimate the maximum number of people standing in a given area.

## Screenshots

<img width="1436" alt="screenshot" src="https://user-images.githubusercontent.com/10114716/208234291-6de08560-40a7-4750-bef9-ab16a9bebcd7.png">

## Installation

To install the project, you will need to have Node.js and Vue.js installed on your machine. Then, follow these steps:

```bash
git clone https://github.com/paraboul/mapchecking.git # Clone the repository
cd mapchecing # Navigate to the project directory
yarn # Install the dependencies
yarn dev # Start the development server
```

## Usage

To use the tool, open your browser and go to http://localhost:5173. Then, follow the prompts on the screen to input the dimensions of the area and the number of people. The tool will then calculate and display the maximum capacity.

## Contributing

We welcome contributions to the project! If you have an idea for a new feature or have found a bug, please open an issue or submit a pull request.