diff options
| author | Ben V. Brown <[email protected]> | 2019-08-19 07:54:16 +1000 |
|---|---|---|
| committer | Ben V. Brown <[email protected]> | 2019-08-19 07:54:16 +1000 |
| commit | bafe43fc63f0b8741e674a0100987b4fa67e82cf (patch) | |
| tree | 99c929287d7cce7443bd039ad6027524e2fddf67 /development.md | |
| parent | 1d4f4822ed781f4ca01eb13008c5e6130563d2db (diff) | |
| download | IronOS-bafe43fc63f0b8741e674a0100987b4fa67e82cf.tar.gz IronOS-bafe43fc63f0b8741e674a0100987b4fa67e82cf.zip | |
Updating documentation
Diffstat (limited to 'development.md')
| -rw-r--r-- | development.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/development.md b/development.md new file mode 100644 index 00000000..aa2d99d9 --- /dev/null +++ b/development.md @@ -0,0 +1,21 @@ +# Development + +Building this software can be performed two ways, using the STMCubeIDE or using command line tools. + +## STM Cube IDE + +The repository is setup to try and make this painless, when starting the IDE you can import the project by pointing the internal search to the workspace folder of this repository. If you start with a fresh installation, close the welcome screen tab, and then in the left sidebar, there is an optiom to "import". Select General -> Import existing projects -> Set the top location option to this repositories workspace -> Should find the TS100 project. + +## Developing with command line tools & building a release + +In the `workspace/TS100` folder there is a makefile that can be used to build the repository using command line tools. +when running the `make` command, specify which model of the device & the language you would like to use. + +`make -J8 lang=EN model=TS80` + +To build a release instead, run the build.sh script. This will update translations and also build every language for both TS100 and TS80 models. + +## Updating languages + +To update the language translation files & associated font map, execute the `make_translation.py` code from the translations directory. + |