Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
daronnat authored Dec 16, 2017
1 parent def5a74 commit 9a842cb
Showing 1 changed file with 32 additions and 11 deletions.
43 changes: 32 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,38 @@

# Phonochrome 1.0 :
Colorizing graphemes using a g2p WFST based software.
Phonochrome aims to create the best set of contrasted colors for the maximum number of languages.
For more informations please read the PDF file(s) located in this depository (in french).

Phonochrome aims to create the best set of contrasted colors for the maximum number of languages. Using this set of colors, the software proceed to colorize graphemes using a g2p WFST based approach. For more informations please read the PDF file(s) located in this depository (in french).

## Getting Started

This software requires the following dependencies :
- Phonetisaurus (openfst 1.6.1 branch)
- Google Ngram Library (1.3+)
- OpenFST (1.6+)
- Webcolor and Colormath modules for Python3
Most of the instructions, manuals and scripts are in french. If you need any information please send me an email.

Creators : Sylvain Daronnat & Elena Melnikova
(Grenoble Alpes University - Master IdL)
- Contact : [email protected]

### Prerequisites

* Python3
* PHP7/HTML5/CSS (for the interface only)

## Built With

* [Phonetisaurus openfst 1.6.1 branch](https://github.com/AdolfVonKleist/Phonetisaurus/tree/openfst-1.6.1) - The main library used
* [Google Ngram Library 1.3+](http://www.openfst.org/twiki/bin/view/GRM/NGramLibrary) - Required library
* [OpenFST 1.6+](http://www.openfst.org/twiki/bin/view/FST/WebHome) - Required library
* [Webcolor](https://pypi.python.org/pypi/webcolors/) - Python module
* [Colormath](https://pypi.python.org/pypi/colormath/) - Python module

## Authors

* **Sylvain Daronnat** - [Sylvain Daronnat's github](https://github.com/Daronnat)
* **Elena Melnikova**

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

## Acknowledgments

* The K3M research unit
* INALCO
* LIDILEM
* Grenoble Alpes University

0 comments on commit 9a842cb

Please sign in to comment.