Tooling

Build the app

Install Python >= 3.6 and Node.js. On Windows, the recommended Node.js version is 10.17.x.

Install dependencies and start development:

yarn install
yarn start

Attention

Use yarn run check for checking the style of sources and yarn prettify for fixing them. CI will fail if non-pretty sources are pushed.

Note

Use envvar ICESTUDIO_APIO for using apio from a custom location.

Build the docs

cd docs
pip3 install -r requirements.txt
make html
firefox _build/html/index.html

Internationalisation

Use yarn gettext to extract the labels from the code.

Localisation

Basque, Catalan, Chinese, Czech, Dutch, English, French, Galician, German, Greek, Italian, Korean, Russian, Spanish...

*.po sources for localisation are located in locale. For contributing, add or update the app translations using Poedit.

Package for distribution

yarn dist

  • GNU/Linux: (linux32,linux64).zip

  • Windows: (win32,win64).zip

  • Mac OS: osx64.zip

Apio configuration

Apio backend is configured in the app/package.json file:

  • apio.min: minimum version (>=)

  • apio.max: maximum version (<)

  • apio.extras: list of external Python programmers (blackiceprog, tinyfpgab)

  • apio.external: load an external Apio package instead of the default one (e.g. /path/to/my/apio)

  • apio.branch: install Apio from the repository branch instead of PyPI.

An external Apio package can be also set on runtime using the ICESTUDIO_APIO environment variable.

References