You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+23-3Lines changed: 23 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -2,15 +2,25 @@
2
2
3
3
OCRAnno is a text annotation tool designed to provide annotated data to improve the results of OCR systems. OCRAnno is being developed as part of a collaboration between the Institute of Informatics at UFRGS and Petrobras.
4
4
5
-
## Requirements
5
+
## Functionalities
6
+
7
+
* Interface to annotate texts extracted using OCR;
8
+
* The system shows the source PDF document and the sentence that may need correction;
9
+
* Annotators can search for the sentence to identify where it occurs on the page;
10
+
* Random documents by annotator;
11
+
* If the original document is of poor quality and impossible to read, annotators can classify it as illegible;
12
+
* Tour for the annotators to get familiar with the interface;
13
+
* Admin controller to follow the annotation progress, with CRUD operations over the documents and users list.
14
+
15
+
## Requirements and tools
6
16
7
17
OCRAnno was developed using the open-source PHP web framework, Laravel 7.0. The requirements are the same as the framework, found in the [documentation (version 7.x)](https://laravel.com/docs/7.x). Laravel has support to different databases, the chosen one was [MySQL](https://www.mysql.com/).
8
18
9
19
To run the project you will need to have installed [Composer](https://getcomposer.org/).
10
20
11
21
## How to run the project
12
22
13
-
After cloning the project, inside the project folder, create the file `.env`, by copying and renaming the `.env.exemple` file. This file has basic settings for Laravel. If necessary, you will need to configure the database connection, default admin user, and mail settings (to recover the user's password).
23
+
After cloning the project, inside the project folder, create the file `.env`, by copying and renaming the `.env.exemple` file. This file has basic settings for Laravel. If necessary, you will need to configure the **database connection**, default **admin user**, and **mail settings** (to recover the user's password).
14
24
15
25
Before running the commands, you have to create the MySQL database named `ocranno`, the same `DB_DATABASE` informed in `.env` file.
16
26
@@ -24,7 +34,11 @@ $ php artisan serve
24
34
```
25
35
The last command will generate a locally URL to access the system into the browser.
26
36
27
-
If you have some doubts or problems to run, maybe this [link](https://gist.github.com/hootlex/da59b91c628a6688ceb1) can help.
37
+
This [link](https://gist.github.com/hootlex/da59b91c628a6688ceb1) may provide extra information, if needed.
38
+
39
+
## User information
40
+
41
+
With the system running, the user will find a interactive tour in the first access (which can be accessed again later) providing the necessary information to follow up with the annotations. The admin user has the same functionalities as the default user, but also has controller with CRUD operations over the documents, it also can list and search all users, documents and sentences.
28
42
29
43
------
30
44
@@ -43,3 +57,9 @@ If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Lar
43
57
## License
44
58
45
59
The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
0 commit comments