Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Apolo151 committed Feb 9, 2025
1 parent 4330baa commit 24c7153
Showing 1 changed file with 32 additions and 7 deletions.
39 changes: 32 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,38 @@
# equation-solver
A graphical program to solve simple mathematical equations.
Takes as input two equations of `x`, solves them, and plots the equations with their solutions.
# Equation Solver 📈

[![Python 3.10](https://img.shields.io/badge/python-3.10-blue.svg)](https://www.python.org/downloads/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

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

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

## Requirements
- Python 3.6 or higher (Python 3.10 recommended)
## Features ✨
- Graphical user interface (GUI) with input validation
- Supports equation solving and intersection point detection
- Interactive matplotlib plots embedded in the GUI
- Error handling with user-friendly messages
- Cross-platform compatibility (Windows/Linux)

## Supported Operations 🔢
| Operation | Symbol/Function | Example |
|----------------|-----------------|-------------------|
| Addition | `+` | `x + 3` |
| Subtraction | `-` | `5 - x` |
| Multiplication | `*` | `2 * x` |
| Division | `/` | `x / 4` |
| Exponentiation | `^` | `x^2` |
| Square root | `sqrt()` | `sqrt(x + 1)` |
| Logarithm base10| `log10()` | `log10(2*x)` |


## Requirements 📋
- Python 3.10+ (recommended)
- PySide2 (GUI framework)
- Matplotlib (Plotting)
- NumPy (Numerical operations)
- SciPy (Equation solving)
- SymPy (Symbolic mathematics)

## Installation
1. Clone the repository
Expand Down

0 comments on commit 24c7153

Please sign in to comment.