Skip to content

Commit

Permalink
docs: fix config file name
Browse files Browse the repository at this point in the history
  • Loading branch information
roedoejet committed Apr 21, 2024
1 parent 3d9b1bb commit aebce19
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ pip install mothertongues
If you just want to try something out you can use the mothertongues command line to create a configuration and some sample data:

1. `poetry run python3 cli.py new-project`
2. Then run your dictionary: `poetry run python3 cli.py build-and-run <YourDictionaryConfigDirPath>/mtd.config.json`
2. Then run your dictionary: `poetry run python3 cli.py build-and-run <YourDictionaryConfigDirPath>/config.mtd.json`

### Local Install

Expand Down
4 changes: 2 additions & 2 deletions docs/guides/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ structure similar to the one [described in this guide](#file-structure).

Then run:

`mothertongues build-and-run <path_to_mtd.config.json>`
`mothertongues build-and-run <path_to_config.mtd.json>`

And your dictionary will be served at [http://localhost:3636](http://localhost:3636)

Expand All @@ -32,7 +32,7 @@ First, you need to export the dictionary data required by any MTD UI.
2. Then, build the dictionary using the `mothertongues export` command to create
necessary data:

`mothertongues export <path_to_mtd.config.json> <output_folder>`
`mothertongues export <path_to_config.mtd.json> <output_folder>`


This will create a file called `dictionary_data.json` which is the file you will need to transfer to your MTD UI in the next section.
Expand Down
6 changes: 3 additions & 3 deletions docs/guides/prepare.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,18 @@ The most time-intensive part of building your dictionary, depending on how you w

## Project folder structure

To generate a sample project that you can edit to suit your needs, use the `mothertongues new-project` command. For example `mothertongues new-project --outdir . --name 'DanishDictionary'` will build a folder called 'DanishDictionary in the current directory'. It will include some sample data ('data.xlsx') and a [MTD configuration file](#mtd-language-configuration-file) ('mtd.config.json').
To generate a sample project that you can edit to suit your needs, use the `mothertongues new-project` command. For example `mothertongues new-project --outdir . --name 'DanishDictionary'` will build a folder called 'DanishDictionary in the current directory'. It will include some sample data ('data.xlsx') and a [MTD configuration file](#mtd-language-configuration-file) ('config.mtd.json').

```raw
📦DanishDictionary
┣ 📜data.xlsx
┗ 📜mtd.config.json
┗ 📜config.mtd.json
```

## MTD Configuration file

!!! tip
In the [starter](https://github.com/MotherTongues/mtd-starter), the language configuration file is found here: `mtd-starter/mtd.config.json`
In the [starter](https://github.com/MotherTongues/mtd-starter), the language configuration file is found here: `mtd-starter/config.mtd.json`


Every dictionary must have a configuration file, which helps define which data belongs to your dictionary and meta data like your dictionary's [alphabet](#customized-alphabet)
Expand Down

0 comments on commit aebce19

Please sign in to comment.