update Readme

README.md

@@ -13,12 +13,17 @@ This is Text-based user interface program that use to solve matrix and algebra p
   - [Install and Usage](#install-and-usage)
   - [Guide/Documentation](#guidedocumentation)
     - [Polynomial](#polynomial)
+    - [Matrix](#matrix)
   - [Contributing](#contributing)
 
 
 ## Overview
 
-...
+Calculator for Matrix and Algebra can solve some expression that not too complex such as expression that doesn't have much nested parentheses.
+
+It can solve Single Variable Equation and can expand the polynomial.
+
+Some function maybe buggy but If the expression is not contain math function or nested parentheses, It works at its finest. 
 
 ## Features
 
@@ -37,18 +42,41 @@ This program has been created in **Python 3.10.5** and has the following built-i
 
 ## Program design
 
-...
+- This is UML Class Diagram of this program.
+
+![](classes_myproject.png)
+![](packages_myproject.png)
 
 ## Code structure
 
-...
+**[main.py](main.py)**
+ - This file is the main file that read the input and return the result.
+
+**[file_read_write.py](file_read_write.py)**
+ - Contains function that use to read and write json file.
+
+**[polynomial.py](nessesary\polynomial.py)**
+ - Implement Class Polynomial that contain function to solve, change between array and string form.
+
+**[matrix.py](nessesary\matrix.py)**
+ - Implement Class Matrix that contain function to find determiannt, inverse and Tranpose.
+
+**[fraction.py](nessesary\fraction.py)**
+ - Implement Class Fraction that contain function to turn float into fraction and can evaluate reduce form.
+  
+**[parser.py](nessesary\parser\parser.py)**
+ - Contain all parsing function such as function that parse string of polynomial to array list.
+
+**[processing.py](nessesary\equation\processing.py)**
+ - process the string data inside the program. Use function in this file with polynomial.py to solve the single-variable equation.
+
 
 ## Install and Usage
 
 Clone this repository and run the **main.py**
 
 ````
-$ git clone https://github.com/Sosokker/Algebraic-Solving-Tool
+$ git clone https://github.com/Sosokker/Calculator-for-Matrix-and-Algebra
 ````
 
 ## Guide/Documentation
@@ -82,12 +110,82 @@ Every command you put in and result of it will be save in **history.json** file.
 
   - This Command use to print all property of the polynomial that user input.
 
-  ````
-  [1] polynomial[x^2+2x+1]
+  ````css
+  [1]: poly[3x^2-4x-10] 
+  Input Polynoimial: 3x^2-4x-10
+  ===============================
+  Solution to 3x^2-4x-10 = 0
+  Answer #1: x = -1.2769839649484336 | x = -798114978092771/625000000000000
+  Answer #2: x = 2.610317298281767 | x = 2610317298281767/1000000000000000
+
+  [2]: poly[x+31-x^2] 
+  Input Polynoimial: x+31-x^2
+  =============================
+  Solution to x+31-x^2 = 0
+  Answer #1: x = 6.0901699437494745 | x = 12180339887498949/2000000000000000
+  Answer #2: x = -5.0901699437494745 | x = -10180339887498949/2000000000000000
+  ===============================
   
+### Basic Operation
+    Evaluate operation of Matrix, Polynomial, algebra element.
+
+
+- <span style="color:yellow">evaluate[<span style="color:lightblue">expression</span>]</span>
+-> expression: string(mathematic expression) e.g. evaluate[1+2(5)]
+
+  - Evaluate the operation of expression, Matrix, Polynomial.
+
+  ````css
+  [1]: evaluate[1+2(5)]       
+  Result: 11
   ````
 
 
+### Matrix
+&nbsp;&nbsp;&nbsp;&nbsp;Matrix in this class store in form of nested list.
+- <span style="color:yellow">Matrix[<span style="color:lightblue">expression</span>]</span>
+-> expression: nested list
+
+  - This Command use to print all property of the Matrix that user input.
+
+  ````css
+  [1]: Matrix[[1,2],[3,4]]
+  Input Matrix: Matrix(([1, 2], [3, 4]))
+  Determinant: -2
+  Tranpose Matrix: Matrix([[1, 3], [2, 4]])
+  Inverse Matrix: Matrix([[-2.0, 1.0], [1.5, -0.5]])
+  ````
+
+- <span style="color:yellow">det[<span style="color:lightblue">expression</span>]</span>
+-> expression: nested list
+
+  - This Command use to find determinant of matrix.
+
+  ````css
+  [1]: det[[1,2],[3,4]]    
+  Determinant: -2
+  ````
+
+- <span style="color:yellow">tranpose[<span style="color:lightblue">expression</span>]</span>
+-> expression: nested list
+
+  - This Command use to find tranpose of matrix.
+
+  ````css
+  [1]: det[[1,2],[3,4]]    
+  Determinant: -2
+  ````
+
+- <span style="color:yellow">inverse[<span style="color:lightblue">expression</span>]</span>
+-> expression: nested list
+
+  - This Command use to find inverse of matrix.
+
+  ````css
+  [1]: det[[1,2],[3,4]]    
+  Determinant: -2
+  ````
+
 ## Contributing
 
 Pull requests are always welcome and that would be a honor. This first Python project I've dones. I practice using OOP and using github in this work so  many parts of code look a bit messy. 🙈