diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 069b7d4..680187b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,6 +31,12 @@ To install Node.js dependencies: npm install ``` +### Building + +To build Anki `apkg` files from the CSVs run the script `scripts/generate-decks.py`. + +To update screenshots of the templates run the command `npm run generate-screenshots`. + ## Making Changes ### CSV Format @@ -42,12 +48,6 @@ The CSV schema contains the following fields - `tags` - Metadata for the note that could be used by various Anki apps for advanced customisation. The existing data are relics from the previous deck that the project was sourced from. - `guid` - The “Globally Unique Identifier” used by Anki to keep a stable reference of notes. For new entries we can ignore adding this and the project should autogenerate a new guid. Changing this field would result in losing existing progress or history within your Anki app. -### Building - -To build Anki `apkg` files from the CSVs run the script `scripts/generate-decks.py`. - -To update screenshots of the templates run the command `npm run generate-screenshots`. - ## Submitting changes Please send a [GitHub Pull Request to open-anki-jlpt-decks](https://github.com/jamsinclair/open-anki-jlpt-decks/pull/new/master) and follow the Pull Request template.