Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 34 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@


### Застосування ###
зі словником можна робити дві речі:
зі словником можна робити дві речі:
1. згенерувати всі можливі словоформи для слів, що вже є в словнику (див. параграф «Як запускати» нижче)
2. генерувати форми для довільних слів в інтерактивному режимі: [докладніше](doc/interactive_mode.md)

Expand All @@ -36,23 +36,27 @@
* Встановити java (JDK 11 або новішу)
* (Лише для Windows) встановити і запустити git bash
* Клонувати проект: `git clone https://github.com/brown-uk/dict_uk.git`
* Зайти в теку проекту: cd dict_uk
* Зайти в теку проекту: `cd dict_uk`

### Як запускати ###

`./gradlew expand`

або для Windows:

`bin/expand_win.sh`
```sh
./gradlew expand
```

або для Windows:

```sh
bin/expand_win.sh
```

На виході:
На виході:

* out/dict_corp_vis.txt - словник у візуальному форматі (з відступами, згрупований за лемами) для перегляду, аналізу і опрацьовування
* out/dict_corp_lt.txt - словник у табличному форматі для використання в ПЗ, зокрема з цього файлу генеруємо словник morfologik, що використовується в LanguageTool
* out/words.txt - список всіх відомих словоформ
* out/words_spell.txt - список всіх відомих словоформ, правильних з погляду правопису
* out/lemmas.txt - список лем
* `out/dict_corp_vis.txt` - словник у візуальному форматі (з відступами, згрупований за лемами) для перегляду, аналізу і опрацьовування
* `out/dict_corp_lt.txt` - словник у табличному форматі для використання в ПЗ, зокрема з цього файлу генеруємо словник morfologik, що використовується в LanguageTool
* `out/words.txt` - список всіх відомих словоформ
* `out/words_spell.txt` - список всіх відомих словоформ, правильних з погляду правопису
* `out/lemmas.txt` - список лем

### Ліцензія ###

Expand All @@ -76,8 +80,8 @@ Copyright (c) 2023 Андрій Рисін (arysin@gmail.com), Василь Ст


### Description ###
For all files in data/dict the project generates all possible word forms with POS tags
by using affix rules from files in data/affix.
For all files in data/dict the project generates all possible word forms with POS tags
by using affix rules from files in data/affix.


### Required software ###
Expand All @@ -86,23 +90,28 @@ Copyright (c) 2023 Андрій Рисін (arysin@gmail.com), Василь Ст


### How to run ###
`./gradlew expand`

or on Windows:
```sh
./gradlew expand
```

or on Windows:

`bin/expand_win.sh`
```sh
bin/expand_win.sh
```

Output:
Output:

* out/dict_corp_vis.txt - Dictionary in visual (indented) format for review, analysis or conversion
* out/dict_corp_lt.txt - Dictionary in flat format (is used for preparing morfologik dictionary that can be used by LanguageTool)
* out/words.txt - list of all unique known words
* out/words_spell.txt - words valid for spelling
* out/lemmas.txt - list of unique lemmas
* `out/dict_corp_vis.txt` - Dictionary in visual (indented) format for review, analysis or conversion
* `out/dict_corp_lt.txt` - Dictionary in flat format (is used for preparing morfologik dictionary that can be used by LanguageTool)
* `out/words.txt` - list of all unique known words
* `out/words_spell.txt` - words valid for spelling
* `out/lemmas.txt` - list of unique lemmas

### Building under docker ###

```
```sh
sudo docker build -t brown-uk/dict_uk .
sudo docker run -d --name dict_uk brown-uk/dict_uk /bin/bash
sudo docker cp dict_uk:/src/out/ ./out
Expand Down