diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 85 |
1 files changed, 85 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..f63d455 --- /dev/null +++ b/README.md @@ -0,0 +1,85 @@ +# Web Calculator (iOS Calculator Lookalike) + +This is a simple web calculator built with HTML, CSS, and JavaScript. + +## Usage + +1. Clone this repository to your local machine: + + ```bash + git clone https://github.com/jsutsaumit/web-calculator.git + ``` +2. Navigate to the project directory: + + ```bash + cd web-calculator + ``` + +3. Start the Flask server: + + ```bash + python server.py + ``` + +4. Open your web browser and access the calculator at `http://127.0.0.1:5000/`. + +## File Structure + +- `index.html`: The main HTML file for the calculator interface. +- `style.css`: CSS file for styling the calculator. +- `script.js`: JavaScript file for calculator logic. +- `server.py`: Python server using Flask for. + +## Customize + +Feel free to customize the calculator's appearance and behavior by modifying the HTML, CSS, and JavaScript files. + +## License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. + +--- + +## Contributing to Web Calculator + +1. **Fork the Repository:** Click the "Fork" button on the top right corner of the repository page to create a copy of the project in your GitHub account. + +2. **Clone Your Fork:** Clone your forked repository to your local machine using the following command: + + ```bash + git clone https://github.com/<your-username>/web-calculator.git + ``` + +3. **Create a Branch:** Create a new branch for your work. Use a descriptive name for your branch to indicate the feature or bug you are working on: + + ```bash + git checkout -b feature-name + ``` + +4. **Make Changes:** Make your desired changes or additions to the project code. + +5. **Commit Your Changes:** Commit your changes with a descriptive commit message: + + ```bash + git commit -m "Added feature XYZ" + ``` + +6. **Push Your Changes:** Push your changes to your fork on GitHub: + + ```bash + git push origin feature-name + ``` + +7. **Create a Pull Request:** Go to your forked repository on GitHub and click the "New Pull Request" button. Provide a detailed description of your changes in the PR. + +8. **Wait for Review:** Your PR will be reviewed by the project maintainers. Make any necessary updates based on feedback. + +9. **Merge:** Once your PR is approved, it will be merged into the main project. + +## License + +By contributing to this project, you agree to the [MIT LICENSE](LICENSE). + +--- + +Thank you for your contribution! Hope you do many more! |