-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Replace dummy content with the real stuff - what happened?
- Loading branch information
Showing
1 changed file
with
156 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,156 @@ | ||
| Cebuano | ||
| The Cebuano morphology and tools | ||
| ========================================== | ||
|
|
||
| [](https://giellalt.github.io/MaturityClassification.html) | ||
|  | ||
| [](https://github.com/giellalt/lang-ceb/issues) | ||
| [](https://github.com/giellalt/lang-ceb/blob/main/LICENSE) | ||
| [](https://github.com/giellalt/lang-ceb/actions) | ||
| [](https://divvun-tc.giellalt.org/api/github/v1/repository/giellalt/lang-ceb/main/latest) | ||
|
|
||
| Download nightly / CI/CD installation packages for testing (contains the core zhfst file(s)): | ||
|
|
||
| [](https://pahkat.uit.no/main/download/speller-ceb?platform=windows&channel=nightly) | ||
| [](https://pahkat.uit.no/main/download/speller-ceb?platform=macos&channel=nightly) | ||
| [](https://pahkat.uit.no/main/download/speller-ceb?platform=mobile&channel=nightly) | ||
|
|
||
| __NB!!__ Note that the nightly / CI/CD installation packages are not tested for language quality, and might contain regressions and errors. | ||
|
|
||
| This repository contains finite state source files for the Cebuano language, | ||
| for building morphological analysers, proofing tools | ||
| and dictionaries. The data and implementation are licenced under LGPLv3 | ||
| licence, also detailed in the | ||
| [LICENSE](https://github.com/giellalt/lang-ceb/blob/main/LICENSE). The | ||
| authors named in the AUTHORS file are available to grant other licencing | ||
| choices. | ||
|
|
||
| Install proofing tools and [keyboards](https://github.com/giellalt/keyboard-ceb) | ||
| for the Cebuano language by using the [Divvun Installer](http://divvun.no) | ||
| (some languages are only available via the nightly channel). | ||
|
|
||
| Spell-checker accuracy: | ||
|
|
||
| [](https://giellalt.github.io/lang-ceb/speller-report.html) | ||
| [](https://giellalt.github.io/lang-ceb/speller-report.svg) | ||
|
|
||
| Download and test speller files | ||
| ------------------------------- | ||
|
|
||
| The speller files downloadable at the top of this page (the `*.bhfst` files) can | ||
| be used with [divvunspell](https://github.com/divvun/divvunspell), to test their | ||
| performance. These files are the exact same ones as installed on users' computers | ||
| and mobile phones. Desktop and mobile speller files differ from each other in the | ||
| error model and should be tested separately — thus also two different downloads. | ||
|
|
||
|
|
||
| Documentation | ||
| ------------- | ||
|
|
||
| Documentation can be found at: | ||
|
|
||
| - [Language specific documentation](https://giellalt.github.io/lang-ceb/) | ||
| - [General documentation](https://giellalt.github.io/) | ||
|
|
||
| Core dependencies | ||
| ----------------- | ||
|
|
||
| In order to compile and use Cebuano language morphology and | ||
| dictionaries, you need: | ||
|
|
||
| - an FST compiler: [HFST](https://github.com/hfst/hfst), [Foma](https://github.com/mhulden/foma) or [Xerox Xfst](https://web.stanford.edu/~laurik/fsmbook/home.html) | ||
| - [VislCG3](https://visl.sdu.dk/svn/visl/tools/vislcg3/trunk) Constraint Grammar tools | ||
|
|
||
| To install VislCG3 and HFST, just copy/paste this into your Terminal on **macOS**: | ||
|
|
||
| ``` | ||
| curl https://apertium.projectjj.com/osx/install-nightly.sh | sudo bash | ||
| ``` | ||
|
|
||
| or terminal on **Ubuntu, Debian or Windows Subsystem for Linux**: | ||
|
|
||
| ``` | ||
| wget https://apertium.projectjj.com/apt/install-nightly.sh -O - | sudo bash | ||
| sudo apt-get install cg3 hfst | ||
| ``` | ||
|
|
||
| or terminal on **RedHat, Fedora, CentOS or Windows Subsystem for Linux**: | ||
|
|
||
| ``` | ||
| wget https://apertium.projectjj.com/rpm/install-nightly.sh -O - | sudo bash | ||
| sudo dnf install cg3 hfst | ||
| ``` | ||
|
|
||
| Alternatively, the Apertium wiki has good instructions on how to [install the dependencies for Mac | ||
| OS X](https://wiki.apertium.org/wiki/Apertium_on_Mac_OS_X) and how to [install | ||
| the dependencies on | ||
| linux](https://wiki.apertium.org/wiki/Installation_of_grammar_libraries) | ||
|
|
||
| Further details and dependencies are described on the GiellaLT [Getting Started](https://giellalt.uit.no/infra/GettingStarted.html) pages. | ||
|
|
||
| Downloading | ||
| ----------- | ||
|
|
||
| Using Git: | ||
| ``` | ||
| git clone https://github.com/giellalt/lang-ceb | ||
| ``` | ||
|
|
||
| Using Subversion: | ||
| ``` | ||
| svn checkout https://github.com/giellalt/lang-ceb.git/trunk lang-ceb | ||
| ``` | ||
|
|
||
| Building and installation | ||
| ------------------------- | ||
|
|
||
| [INSTALL](https://github.com/giellalt/lang-ceb/blob/main/INSTALL) | ||
| describes the GNU build system in detail, but for most users it is the usual: | ||
|
|
||
| ```sh | ||
| ./autogen.sh # This will automatically clone or check out other GiellaLT dependencies | ||
| ./configure | ||
| make | ||
| (as root) make install | ||
| ``` | ||
|
|
||
| Citing | ||
| ------ | ||
|
|
||
| <!-- Add language specific citation stuff here and to the CITATION.cff --> | ||
|
|
||
| If you use language data from more than one GiellaLT language, consider citing | ||
| [our LREC 2022 article on whole | ||
| infra](https://aclanthology.org/2022.lrec-1.125/): | ||
|
|
||
| > Linda Wiechetek, Katri Hiovain-Asikainen, Inga Lill Sigga Mikkelsen, | ||
| Sjur Moshagen, Flammie Pirinen, Trond Trosterud, and Børre Gaup. 2022. | ||
| *Unmasking the Myth of Effortless Big Data - Making an Open Source | ||
| Multi-lingual Infrastructure and Building Language Resources from Scratch*. | ||
| In Proceedings of the Thirteenth Language Resources and Evaluation Conference, | ||
| pages 1167–1177, Marseille, France. European Language Resources Association. | ||
|
|
||
| If you use bibtex, following is as it is on ACL anthology: | ||
|
|
||
| ```bibtex | ||
| @inproceedings{wiechetek-etal-2022-unmasking, | ||
| title = "Unmasking the Myth of Effortless Big Data - Making an Open Source | ||
| Multi-lingual Infrastructure and Building Language Resources from Scratch", | ||
| author = "Wiechetek, Linda and | ||
| Hiovain-Asikainen, Katri and | ||
| Mikkelsen, Inga Lill Sigga and | ||
| Moshagen, Sjur and | ||
| Pirinen, Flammie and | ||
| Trosterud, Trond and | ||
| Gaup, B{\o}rre", | ||
| booktitle = "Proceedings of the Thirteenth Language Resources and Evaluation | ||
| Conference", | ||
| month = jun, | ||
| year = "2022", | ||
| address = "Marseille, France", | ||
| publisher = "European Language Resources Association", | ||
| url = "https://aclanthology.org/2022.lrec-1.125", | ||
| pages = "1167--1177" | ||
| } | ||
| ``` |