spagestic commited on
Commit
aa47bc1
ยท
1 Parent(s): 79bc79a

feat: update README.md for improved clarity and installation instructions

Browse files
Files changed (1) hide show
  1. README.md +59 -24
README.md CHANGED
@@ -9,11 +9,13 @@ app_file: app.py
9
  pinned: false
10
  ---
11
 
12
- # Math Tools
13
 
14
  ## Overview
15
 
16
- This application provides a suite of mathematical tools organized by topic (e.g., Algebra, Calculus, Differential Equations) rather than by education level. It's built with Python and Gradio to offer interactive calculators for various mathematical domains.
 
 
17
 
18
  ## Features
19
 
@@ -28,6 +30,38 @@ This application provides a suite of mathematical tools organized by topic (e.g.
28
  - **Vectors**: Addition, Subtraction, Dot Product, Cross Product
29
  - **Operations Research**: Branch & Bound, Dual Simplex, Simplex Solver Steps
30
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
31
  ## Project Structure
32
 
33
  ```text
@@ -37,35 +71,36 @@ counting/
37
  โ”œโ”€โ”€ README.md # Project documentation (this file)
38
  โ””โ”€โ”€ maths/ # Mathematical modules organized by topic
39
  โ”œโ”€โ”€ arithmetic/ # Arithmetic logic & interfaces
40
- โ”‚ โ”œโ”€โ”€ arithmetic.py
41
- โ”‚ โ””โ”€โ”€ arithmetic_interface.py
42
  โ”œโ”€โ”€ number_theory/ # Number theory logic & interfaces
43
- โ”‚ โ”œโ”€โ”€ number_theory.py
44
- โ”‚ โ””โ”€โ”€ number_theory_interface.py
45
  โ”œโ”€โ”€ algebra/ # Algebra logic & interfaces
46
- โ”‚ โ”œโ”€โ”€ algebra.py
47
- โ”‚ โ””โ”€โ”€ algebra_interface.py
48
  โ”œโ”€โ”€ equations/ # Equation solvers & interfaces
49
- โ”‚ โ”œโ”€โ”€ equations.py
50
- โ”‚ โ””โ”€โ”€ equations_interface.py
51
  โ”œโ”€โ”€ geometry/ # Trigonometry & geometry logic & interfaces
52
- โ”‚ โ”œโ”€โ”€ geometry.py
53
- โ”‚ โ””โ”€โ”€ geometry_interface.py
54
  โ”œโ”€โ”€ calculus/ # Calculus logic & interfaces
55
- โ”‚ โ”œโ”€โ”€ calculus.py
56
- โ”‚ โ””โ”€โ”€ calculus_interface.py
57
  โ”œโ”€โ”€ differential_equations/ # ODE solvers & interfaces
58
- โ”‚ โ”œโ”€โ”€ differential_equations.py
59
- โ”‚ โ””โ”€โ”€ differential_equations_interface.py
60
  โ”œโ”€โ”€ matrices/ # Matrix operations logic & interfaces
61
- โ”‚ โ”œโ”€โ”€ matrices.py
62
- โ”‚ โ””โ”€โ”€ matrices_interface.py
63
  โ”œโ”€โ”€ vectors/ # Vector operations logic & interfaces
64
- โ”‚ โ”œโ”€โ”€ vectors.py
65
- โ”‚ โ””โ”€โ”€ vectors_interface.py
66
  โ””โ”€โ”€ operations_research/ # Operations research solvers & interfaces
67
- โ”œโ”€โ”€ operations_research_interface.py
68
- โ”œโ”€โ”€ BranchAndBoundSolver.py
69
- โ”œโ”€โ”€ DualSimplexSolver.py
70
- โ””โ”€โ”€ simplex_solver_with_steps.py
71
  ```
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
9
  pinned: false
10
  ---
11
 
12
+ [![Python](https://img.shields.io/badge/python-3.8%2B-blue.svg)](https://www.python.org/downloads/) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
13
 
14
  ## Overview
15
 
16
+ Math Tools is a suite of interactive mathematical calculators and solvers, organized by topic (Algebra, Calculus, Differential Equations, etc.) and built with Python and Gradio. It is designed for students, educators, and anyone needing quick, visual math solutions.
17
+
18
+ ---
19
 
20
  ## Features
21
 
 
30
  - **Vectors**: Addition, Subtraction, Dot Product, Cross Product
31
  - **Operations Research**: Branch & Bound, Dual Simplex, Simplex Solver Steps
32
 
33
+ ---
34
+
35
+ ## Getting Started
36
+
37
+ ### Installation
38
+
39
+ 1. **Clone the repository:**
40
+
41
+ ```bash
42
+ git clone https://github.com/yourusername/math-tools.git
43
+ cd math-tools
44
+ ```
45
+
46
+ 2. **Install dependencies:**
47
+
48
+ ```bash
49
+ pip install -r requirements.txt
50
+ ```
51
+
52
+ 3. **Run the app:**
53
+
54
+ ```bash
55
+ python app.py
56
+ ```
57
+
58
+ ### Usage
59
+
60
+ - Open the app in your browser (Gradio will provide a local URL).
61
+ - Select a topic tab and use the calculators or solvers interactively.
62
+
63
+ ---
64
+
65
  ## Project Structure
66
 
67
  ```text
 
71
  โ”œโ”€โ”€ README.md # Project documentation (this file)
72
  โ””โ”€โ”€ maths/ # Mathematical modules organized by topic
73
  โ”œโ”€โ”€ arithmetic/ # Arithmetic logic & interfaces
 
 
74
  โ”œโ”€โ”€ number_theory/ # Number theory logic & interfaces
 
 
75
  โ”œโ”€โ”€ algebra/ # Algebra logic & interfaces
 
 
76
  โ”œโ”€โ”€ equations/ # Equation solvers & interfaces
 
 
77
  โ”œโ”€โ”€ geometry/ # Trigonometry & geometry logic & interfaces
 
 
78
  โ”œโ”€โ”€ calculus/ # Calculus logic & interfaces
 
 
79
  โ”œโ”€โ”€ differential_equations/ # ODE solvers & interfaces
 
 
80
  โ”œโ”€โ”€ matrices/ # Matrix operations logic & interfaces
 
 
81
  โ”œโ”€โ”€ vectors/ # Vector operations logic & interfaces
 
 
82
  โ””โ”€โ”€ operations_research/ # Operations research solvers & interfaces
 
 
 
 
83
  ```
84
+
85
+ ---
86
+
87
+ ## Example
88
+
89
+ ![Math Tools Screenshot](docs/screenshot.png)
90
+
91
+ ---
92
+
93
+ ## Contributing
94
+
95
+ Contributions are welcome! To contribute:
96
+
97
+ 1. Fork this repository
98
+ 2. Create a new branch (`git checkout -b feature/your-feature`)
99
+ 3. Commit your changes
100
+ 4. Open a pull request
101
+
102
+ ---
103
+
104
+ ## License
105
+
106
+ This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.