diff --git a/README.md b/README.md index e1a9b71..411ac40 100644 --- a/README.md +++ b/README.md @@ -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 /mtd.config.json` +2. Then run your dictionary: `poetry run python3 cli.py build-and-run /config.mtd.json` ### Local Install diff --git a/docs/guides/build.md b/docs/guides/build.md index 1e945a5..9c0e27b 100644 --- a/docs/guides/build.md +++ b/docs/guides/build.md @@ -20,7 +20,7 @@ structure similar to the one [described in this guide](#file-structure). Then run: -`mothertongues build-and-run ` +`mothertongues build-and-run ` And your dictionary will be served at [http://localhost:3636](http://localhost:3636) @@ -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 ` +`mothertongues export ` 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. diff --git a/docs/guides/prepare.md b/docs/guides/prepare.md index 78b3749..191a76d 100644 --- a/docs/guides/prepare.md +++ b/docs/guides/prepare.md @@ -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)