Skip to content

Commit

Permalink
Add instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
imnasnainaec committed Nov 13, 2023
1 parent 7a1954e commit 0b06e1c
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,8 @@ A rapid word collection tool. See the [User Guide](https://sillsdev.github.io/Th
5. [Generate License Reports](#generate-license-reports)
6. [Inspect Database](#inspect-database)
7. [Add or Update Dictionary Files](#add-or-update-dictionary-files)
8. [Cleanup Local Repository](#cleanup-local-repository)
8. [Add or Update Backend Semantic Domain Files](#add-or-update-backend-semantic-domain-files)
9. [Cleanup Local Repository](#cleanup-local-repository)
3. [Setup Local Kubernetes Cluster](#setup-local-kubernetes-cluster)
1. [Install Rancher Desktop](#install-rancher-desktop)
2. [Install Docker Desktop](#install-docker-desktop)
Expand Down Expand Up @@ -461,8 +462,8 @@ To browse the database locally during development, open MongoDB Compass Communit
### Add or Update Dictionary Files

The dictionary files for spell-check functionality in _The Combine_ are split into parts to allow lazy-loading, for the
sake of devices with limited bandwidth. There are scripts for generating these files in `src/resources/dictionaries/`;
files in this directory should _not_ be manually edited.
sake of devices with limited bandwidth. These files in `src/resources/dictionaries/` are generated by scripts and should
_not_ be manually edited.

The bash script `scripts/fetch_wordlists.sh` is used to fetch dictionary files for a given language (e.g., `es`) from
the [LibreOffice dictionaries](https://cgit.freedesktop.org/libreoffice/dictionaries/) and convert them to raw wordlists
Expand Down Expand Up @@ -495,6 +496,23 @@ Adjust the `-t`/`--threshold` and `-T`/`--Threshold` parameters to split a wordl

The top of each language's `index.ts` file states which values of `-m`, `-t`, and `-T` were used for that language.

### Add or Update Backend Semantic Domain Files

The Backend semantic domain files are for generating a `.lift-ranges` file during export. (This is only when the
projected has no imported `.lift-ranges` file). The semantic domain files `Backend/Data/ddp4-<lang>.json` are generated
by scripts and should _not_ be manually edited.

The deploy script `deploy/scripts/sem_dom_import.py` has a `--simple/-s` argument for generating these simplified domain
files.

```bash
python ./deploy/scripts/sem_dom_import.py deploy/scripts/semantic_domains/xml/* -o Backend/Data/ -s
```

If you add or remove any languages from the contents of `Backend/Data/`, it is necessary to accordingly update the
`<None Remove="Data\ddp4-...` and `<EmbeddedResource Include="Data\ddp4-...` lines in `Backend/BackendFramework.csproj`,
as well as `List<string> sdLangs` in `CreateLiftRanges` in `Backend/Services/LiftServices.cs`.

### Cleanup Local Repository

It's sometimes possible for a developer's local temporary state to get out of sync with other developers or CI. This
Expand Down

0 comments on commit 0b06e1c

Please sign in to comment.