Skip to content

Commit

Permalink
New README
Browse files Browse the repository at this point in the history
  • Loading branch information
glauberrleite committed Aug 9, 2016
1 parent 249371d commit 69fff08
Showing 1 changed file with 20 additions and 5 deletions.
25 changes: 20 additions & 5 deletions README.md
@@ -1,5 +1,24 @@
# Lexicanalytics
Lexicanalytics offers a set of functionalities to help linguistics researchers with lexical studies, when they are manipulating and retrieving information from text data.

Lexicanalytics is a tool that helps researchers working in the area of text analysis to get lexical metrics and some others measurements. Aside, it gives some statistical outputs for those who may incorporate multiple productions analysis. It is free by nature and is available for use without restrictions, although it is focused in academic works and is released with a GPL License to protect the rights of reuse, for more information see the license.

## Highlighted functionalities


* Lexical and textual measures like number of words, number of lines, TTR.
* Multiple productions analysis at once.
* Statistical measurements for the sample.
* List and search of word occurrences in all or single text.
* Charts for productions overview and words occurrences.
* Reports ranking productions measures.
* General report save to text.


## Running

If you got a release, all you need is a relatively updated Java Runtime Environment ([JRE](https://www.java.com/en/download/)). So there is no problem running it on Linux, Windows or Mac. Then, run the jar file named lexicanalytics and the program should work.

**Warning:** OpenJDK versions may work if the user have built [openJFX](http://openjdk.java.net/projects/openjfx/) because the Lexicanalytics application is based on JavaFX. If the user is working with Oracle's JDK then JavaFX is already working.

## Building and Distribution

Expand All @@ -13,10 +32,6 @@ To produce a jar file, there may have alternative ways of doing this, but we use
5. Right click on it and choose "Run As" followed by "Ant Build";
6. After the procedure the distribution jar is inside the "dist" directory (within "build").

_Notice that the jar file needs the "libs" directory to correctly function! So Distribute the jar file with the "libs" directory in the same path!_



## License

Lexicanalytics is a free software developed and distributed under the GNU Public License Version 3. In the Project's root directory you can see the LICENSE.

0 comments on commit 69fff08

Please sign in to comment.