Skip to content

Commit f46808e

Browse files
authored
Update README.md
1 parent 2e101f6 commit f46808e

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

README.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,25 @@
22

33
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.
44

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
616

717
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/).
818

919
To run the project you will need to have installed [Composer](https://getcomposer.org/).
1020

1121
## How to run the project
1222

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).
1424

1525
Before running the commands, you have to create the MySQL database named `ocranno`, the same `DB_DATABASE` informed in `.env` file.
1626

@@ -24,7 +34,11 @@ $ php artisan serve
2434
```
2535
The last command will generate a locally URL to access the system into the browser.
2636

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.
2842

2943
------
3044

@@ -43,3 +57,9 @@ If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Lar
4357
## License
4458

4559
The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
60+
61+
------
62+
63+
### Team:
64+
Developers: Lucas L Oliveira ([email protected]) <br>
65+
Coordination: Viviane P Moreira ([email protected])

0 commit comments

Comments
 (0)