Skip to content

Commit d44ca76

Browse files
added more details and enhancing docs
1 parent 8c28c8f commit d44ca76

File tree

2 files changed

+24
-5
lines changed

2 files changed

+24
-5
lines changed

.github/workflows/main.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Run MATLAB Script on GitHub-Hosted Runner
1+
name: MATLAB Script
22
on:
33
# Triggers the workflow when changes are pushed but only for the "master" branch
44
push:

README.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,31 @@
11
# Offline Handwritten Text Recognition
22
![Run MATLAB Script](https://github.com/akshaygupta-dev/OfflineHandwrittenTextRecognition/actions/workflows/main.yml/badge.svg?event=push)
3-
![Graphical User Interface](MatlabGUI/GUI_In_Matlab.JPG "GUI")
43

5-
* To try this program, run the following command in matlab's terminal:
4+
<img src="./MatlabGUI/GUI_In_Matlab.JPG" width="600" height="400">
5+
6+
### To try this program, run the following command in matlab's terminal:
67

78
```
89
run(index)
910
```
10-
* If you want to train network from scratch, please see the code in [trainYourOwnNetwork](/trainYourOwnNetwork/) folder.
1111

12-
* If you want to create a graphical user interface like the photo above, please see the code in [MatlabGUI](/MatlabGUI/) folder.
12+
### Train your own Neural Network
13+
14+
If you want to train network from scratch, please see the code in [trainYourOwnNetwork](/trainYourOwnNetwork/) folder.
15+
16+
### Build your own GUI
17+
18+
If you want to build a graphical user interface like the image above, please see the code in [MatlabGUI](/MatlabGUI/) folder.
19+
20+
### READMEs
21+
22+
In addition to the README you're reading right now, this repo includes other READMEs that describe the purpose of each subdirectory in more detail:
23+
24+
- [MatlabGUI/README.md](MatlabGUI/README.md)
25+
- [segmentedImages/README.md](segmentedImages/README.md)
26+
- [testImages/README.md](testImages/README.md)
27+
- [trainYourOwnNetwork/README.md](trainYourOwnNetwork/README.md)
28+
29+
### License
30+
31+
All the assets, content, and data folders are licensed under a [GNU GENERAL PUBLIC LICENSE](LICENSE).

0 commit comments

Comments
 (0)