Skip to content

Commit 24c7153

Browse files
committed
docs: update readme
1 parent 4330baa commit 24c7153

File tree

1 file changed

+32
-7
lines changed

1 file changed

+32
-7
lines changed

README.md

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,38 @@
1-
# equation-solver
2-
A graphical program to solve simple mathematical equations.
3-
Takes as input two equations of `x`, solves them, and plots the equations with their solutions.
1+
# Equation Solver 📈
2+
3+
[![Python 3.10](https://img.shields.io/badge/python-3.10-blue.svg)](https://www.python.org/downloads/)
4+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
45

6+
A graphical program to solve mathematical equations and visualize their intersections through plotting.
7+
Takes as input two equations of `x`, solves them, and plots the equations with their solutions.
58

6-
- Supported Operations
7-
`+ - / * ^ log10() sqrt()`
89

9-
## Requirements
10-
- Python 3.6 or higher (Python 3.10 recommended)
10+
## Features ✨
11+
- Graphical user interface (GUI) with input validation
12+
- Supports equation solving and intersection point detection
13+
- Interactive matplotlib plots embedded in the GUI
14+
- Error handling with user-friendly messages
15+
- Cross-platform compatibility (Windows/Linux)
16+
17+
## Supported Operations 🔢
18+
| Operation | Symbol/Function | Example |
19+
|----------------|-----------------|-------------------|
20+
| Addition | `+` | `x + 3` |
21+
| Subtraction | `-` | `5 - x` |
22+
| Multiplication | `*` | `2 * x` |
23+
| Division | `/` | `x / 4` |
24+
| Exponentiation | `^` | `x^2` |
25+
| Square root | `sqrt()` | `sqrt(x + 1)` |
26+
| Logarithm base10| `log10()` | `log10(2*x)` |
27+
28+
29+
## Requirements 📋
30+
- Python 3.10+ (recommended)
31+
- PySide2 (GUI framework)
32+
- Matplotlib (Plotting)
33+
- NumPy (Numerical operations)
34+
- SciPy (Equation solving)
35+
- SymPy (Symbolic mathematics)
1136

1237
## Installation
1338
1. Clone the repository

0 commit comments

Comments
 (0)