Skip to content

Commit bc15138

Browse files
committed
Add license and further changes to Readme
Add license, change icon and include related projects. Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md
1 parent 4e6343e commit bc15138

2 files changed

Lines changed: 68 additions & 18 deletions

File tree

README.md

Lines changed: 68 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,70 +3,88 @@
33
[![Platform](https://img.shields.io/badge/platform-Android-g.svg)](https://www.android.com)
44
[![API](https://img.shields.io/badge/API-24%2B-brightgreen.svg?style=flat)](https://android-arsenal.com/api?level=24)
55

6-
Arabic Math Solver is Android Application that has the Ability to recognize and solve handwritten equations in Arabic notation.
6+
<img src="./readme/sen.png" align="left" width="100" hspace="10" vspace="10">
7+
8+
Arabic Math Solver is an Android Application that has the Ability to recognize and solve handwritten equations in Arabic notation.
9+
The application provides support to solve a wide range of mathematical problems
10+
e.g. (Simplifying - Solving Polynomials - Integration - Differentiation).
11+
12+
13+
## Table of Contents
14+
15+
- [Screenshots](#screenshots)
16+
- [Features](#features)
17+
- [Assumptions while usage](#assumptions-while-usage)
18+
- [How to use ?](#how-to-use-?)
19+
- [Example demos](#example-demos)
20+
- [Related Projects](#related-projects)
21+
- [License](#license)
722

8-
The application provides support to solve a wide range of mathematical problems e.g. (Simplifying - Solving Polynomials - Integration - Differentiation)
923

10-
<img src="./readme/sen.png" style="float: right;" width="200" hspace="10" vspace="10">
1124

1225
## Screenshots
1326

1427
| Light Theme | Dark Theme |
1528
| :----------------------------------------------------------- | :----------------------------------------------------------- |
1629
| <img src="./readme/light.png" width="200" style="float: left;"> | <img src="./readme/dark.png" width="200" style="float: left;"> |
1730

31+
32+
1833
## Features
19-
1. **Drawing Tools**
34+
35+
1. #### **Drawing Tools**
2036

2137
The user has the ability to use Pen and Eraser to freely draw the equation he wants.
2238

2339

24-
Using Eraser|Using Pen
25-
:--------------------------|:--------------------------
26-
<img src="./readme/eraser.gif" width="200" style="float: left;"> |<img src="./readme/pen.gif" width="200" style="float: left;">
40+
| Using Eraser | Using Pen |
41+
| :----------------------------------------------------------- | :----------------------------------------------------------- |
42+
| <img src="./readme/eraser.gif" width="200" style="float: left;"> | <img src="./readme/pen.gif" width="200" style="float: left;"> |
2743

28-
2. **Resize & Move**
44+
2. #### **Resize & Move**
2945

3046
The user has unlimited space to write the equation using Resize (2 Fingers) & Move (1 Finger) Button.
3147

3248

33-
| Resize | Move |
34-
| :----------------------------------------------------------- | :----------------------------------------------------------- |
35-
| <img src="./readme/resize.gif" width="200" style="float: left;"> | <img src="./readme/move.gif" width="200" style="float: left;"> |
49+
| Resize | Move |
50+
| :----------------------------------------------------------- | :----------------------------------------------------------- |
51+
| <img src="./readme/resize.gif" width="200" style="float: left;"> | <img src="./readme/move.gif" width="200" style="float: left;"> |
3652

37-
3. **Undo & Redo**
53+
3. #### **Undo & Redo**
3854

3955
The user can undo/redo any action he had done easily
4056

4157
<img src="./readme/undo.gif" width="200" style="float: left;">
4258

59+
60+
4361
## Assumptions while usage
4462

4563
##### These are some assumptions that should be followed while using our application to have the best experience with it.
4664

47-
### 1. Dot-less symbols
65+
#### 1. Dot-less symbols
4866

4967
- All characters, symbols and trigonometric symbols that have dots (except division sign ÷) should be written without any dots.
5068

5169
| Letters | Trigonometric Symbols |
5270
| :----------------------------------------------------------- | :----------------------------------------------------------- |
5371
| <img src="./readme/letters.png" height="200" style="float: left;"> | <img src="./readme/trig.png" height="200" style="float: left;"> |
5472

55-
### 2. Un-intersecting symbols
73+
#### 2. Un-intersecting symbols
5674

5775
- All characters and symbols drawn are not intersecting at any point, a valid space that separates any two symbols from each other can be always found.
5876

59-
### 3. Horizontal drawn equation
77+
#### 3. Horizontal drawn equation
6078

6179
- The equation is drawn horizontally without any major inclinations.
6280

6381
| Valid equation | invalid equation |
6482
| :----------------------------------------------------------- | :----------------------------------------------------------- |
6583
| <img src="./readme/valid_inc.png" width="250" style="float: left;"> | <img src="./readme/invalid_inc.png" width="250" style="float: left;"> |
6684

67-
## 4. Fractions and Square roots
85+
### 4. Fractions and Square roots
6886

69-
- The line, that separates denominator from numerator in a fraction, should be covering both the start and end symbols of both denominator and numerator.
87+
- #### The line, that separates denominator from numerator in a fraction, should be covering both the start and end symbols of both denominator and numerator.
7088

7189
| Valid fraction | invalid fraction |
7290
| :----------------------------------------------------------- | :----------------------------------------------------------- |
@@ -78,6 +96,8 @@ The application provides support to solve a wide range of mathematical problems
7896
| :----------------------------------------------------------- | :----------------------------------------------------------- |
7997
| <img src="./readme/valid_sqrt.png" width="250" style="float: left;"> | <img src="./readme/invalid_sqrt.png" width="250" style="float: left;"> |
8098

99+
100+
81101
## How to use ?
82102

83103
1. Draw, in the drawing area, the equation you want to solve.
@@ -88,8 +108,38 @@ The application provides support to solve a wide range of mathematical problems
88108

89109
**N.B :** incase of error, you may also want to pay attention to what is shown in the seen-Arabic-equation (المعادلة) part to ensure that there are no wrong symbols seen.
90110

91-
## Example demo
111+
112+
113+
## Example demos
92114

93115
| Polynomial (إيجاد حدود) | Simplification (تبسيط) | Differentiation (تفاضل) | Integration (تكامل) |
94116
| :----------------------------------------------------------- | ------------------------------------------------------------ | :----------------------------------------------------------- | ------------------------------------------------------------ |
95117
| <img src="./readme/ex_1.gif" width="200" style="float: left;"> | <img src="./readme/ex_2.gif" width="200" style="float: left;"> | <img src="./readme/ex_3.gif" width="200" style="float: left;"> | <img src="./readme/ex_4.gif" width="200" style="float: left;"> |
118+
119+
120+
121+
## Related Projects
122+
123+
[ArabicMathSolver-Server](https://github.com/omarshawky15/ArabicMathSolver-Server)
124+
125+
126+
127+
## License
128+
129+
```
130+
ArabicMathSolver
131+
Copyright (C) 2022 Faculty of Engineering, Alexandria University, Egypt.
132+
133+
This program is free software: you can redistribute it and/or modify
134+
it under the terms of the GNU General Public License as published by
135+
the Free Software Foundation, either version 3 of the License, or
136+
(at your option) any later version.
137+
138+
This program is distributed in the hope that it will be useful,
139+
but WITHOUT ANY WARRANTY; without even the implied warranty of
140+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
141+
GNU General Public License for more details.
142+
143+
You should have received a copy of the GNU General Public License
144+
along with this program. If not, see <http://www.gnu.org/licenses/>.
145+
```

readme/sen.png

12.9 KB
Loading

0 commit comments

Comments
 (0)