From 9ac38068c0d0f6eae31af0f1002e7d3f2e424653 Mon Sep 17 00:00:00 2001 From: lgwarda Date: Thu, 10 Oct 2024 17:00:13 +0200 Subject: [PATCH] Add README and .gitignore files for project documentation and environment management --- .gitignore | 21 +++++++++++++++++++ README.md | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 81 insertions(+) create mode 100644 .gitignore create mode 100644 README.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1b6770d --- /dev/null +++ b/.gitignore @@ -0,0 +1,21 @@ +# Node modules (if using npm) +node_modules/ + +# Logs +*.log + +# Temporary files +*.tmp +*.temp + +# IDE specific files (optional, depending on your editor) +.vscode/ +.idea/ + +# OS generated files +.DS_Store +Thumbs.db + +# Build directories (if applicable) +dist/ +build/ diff --git a/README.md b/README.md new file mode 100644 index 0000000..3bb90b2 --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +# Quadratic Function Visualizer + +## Overview + +The Quadratic Function Visualizer is an interactive web application built using p5.js that allows users to explore and visualize quadratic functions. Users can manipulate the coefficients of the function and see how the graph changes in real-time. This tool is useful for students, educators, and anyone interested in understanding quadratic equations better. + +## Features + +- Interactive sliders to adjust the coefficients \( a \), \( b \), and \( c \) of the quadratic function. +- A movable point on the graph to see the function value at specific \( x \) coordinates. +- Dynamic visualization of the quadratic function as users modify the coefficients. + +## Getting Started + +### Prerequisites + +- A modern web browser (e.g., Chrome, Firefox). +- Basic understanding of HTML and JavaScript is helpful but not required. + +### Installation + +1. Clone the repository or download the project files. + + ```bash + git clone quadratic-function-visualizer + + + cd quadratic-function-visualizer + + + ``` + +2. Open the `index.html` file in your web browser. + +### Project Structure + +- `index.html`: The main HTML file that includes the p5.js library and links to the sketch. +- `sketch.js`: The main JavaScript file containing the logic for the quadratic function visualizer. + +## Usage + +- Adjust the coefficients \( a \), \( b \), and \( c \) using the corresponding sliders to see how the graph changes. +- Move the point using the slider to see the value of the function at different \( x \) positions. + +## Examples + +- Set \( a = 1 \), \( b = 0 \), \( c = 0 \) to visualize the standard parabola. +- Experiment with negative values for \( a \) to see inverted parabolas. + +## License + +This project is licensed under the MIT License. See the LICENSE file for details. + +## Acknowledgments + +- [p5.js](https://p5js.org/) for the graphics and interactive elements. + +### Customization + +Feel free to modify sections or add more details specific to your project, such as additional features, example use cases, or specific installation instructions. If you need any further assistance, let me know!