Skip to content

Commit

Permalink
Update CONTRIBUTING.md (#91)
Browse files Browse the repository at this point in the history
Correction of mistyping.
  • Loading branch information
BoFFire authored Dec 20, 2024
1 parent 46d90d8 commit 3a1e2fe
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Use the Flatpak version of [GNOME Builder](https://apps.gnome.org/Builder) to bu
```

3. Press the "Clone repository…" button
4. Press confirm if asked aboout automatic installation of any dependencies, and wait for them to download
4. Press confirm if asked about automatic installation of any dependencies, and wait for them to download
5. Press the play button in the header bar

## Translating
Expand All @@ -32,7 +32,7 @@ Keypunch does not have any external translation infrastructure as of now, but a

## Adding a Language

This is the technical procedure for adding a text language to Keypunch. To request a language and help with the non-technical aspects, [create a langauge request](https://github.com/bragefuglseth/keypunch/issues/new?assignees=&labels=new+language&projects=&template=language_request.yaml&title=%5BLanguage+Request%5D%3A+) instead. To translate the UI, refer to the section above.
This is the technical procedure for adding a text language to Keypunch. To request a language and help with the non-technical aspects, [create a language request](https://github.com/bragefuglseth/keypunch/issues/new?assignees=&labels=new+language&projects=&template=language_request.yaml&title=%5BLanguage+Request%5D%3A+) instead. To translate the UI, refer to the section above.

1. Add a word list with approximately 200 words to `data/word_lists/{code}.txt`. Replace `{code}` with the code of your language (e.g. `en` or `nb`). If the language has a corresponding list in [Monkeytype's language directory](https://github.com/monkeytypegame/monkeytype/tree/master/frontend/static/languages), you can download that, rename it and run `scripts/json_to_word_list.sh {file_path}` to generate a plain word list. Replace `{file_path}` with a path to the file. You'll need to have `jq` installed for the script to work.
3. Locate and open `src/text_generation.rs`. This is where all language work takes place.
Expand Down

0 comments on commit 3a1e2fe

Please sign in to comment.