feature: Add README file

pull/16/head
Burak Sakalli 2022-12-17 12:01:54 +03:00
rodzic 56b14d211a
commit f14016a4bd
1 zmienionych plików z 28 dodań i 0 usunięć

28
README.md 100644
Wyświetl plik

@ -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.