Adding LICENCE and sample README

3 files changed, 107 insertions, 0 deletions

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..1d17dae
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+.venv
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..b045ee2
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Saumit Dinesan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
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!