Grammalecte  Artifact Content

Artifact a9bb1bbf947bafea536ee6bda36810eca80908b8179b14272f658082a9623f3c:

  • File doc/build.md — part of check-in [29423db53a] at 2017-10-28 09:47:57 on branch FixWebext — [doc] update build.md (user: olr size: 1545) [more...]


# How to build Grammalecte

## Required ##

* Python 3.6
* Firefox Nightly
* NodeJS
  * npm
  * jpm : https://developer.mozilla.org/en-US/Add-ons/SDK/Tools/jpm
  * web-ext : https://developer.mozilla.org/fr/Add-ons/WebExtensions/Getting_started_with_web-ext
* Thunderbird


## Commands ##

**Build a language**

`make.py LANG`

> Generate the LibreOffice extension and the package folder.
> LANG is the lang code (ISO 639).

> This script uses the file `config.ini` in the folder `gc_lang/LANG`.

**First build**

`make.py LANG -js`

> This command is required to generate all necessary files.

**Options**

`-b --build_data`

> Launch the script `build_data.py` in the folder `gc_lang/LANG`.

`-d --dict`

> Generate the indexable binary dictionary from the lexicon in the folder `lexicons`.

`-js --javascript`

> Also generate JavaScript extensions.
> Without this option, only Python modules, data and extensions are generated.

`-t --tests`

> Run unit tests.

`-i --install`

> Install the LibreOffice extension.

`-fx --firefox`

> Launch Firefox Developper (before Firefox 57).
> Unit tests can be lanched from Firefox, with CTRL+SHIFT+F12.

`-we --webext`

> Launch Firefox Nightly (Firefox 57+).
> Unit tests can be lanched from the menu.

`-tb --thunderbird`

> Launch Thunderbird.


## Examples ##

Full rebuild:

        make.py LANG -b -d -js

After modifying grammar rules:

        make.py LANG -t

If you modify the lexicon:

        make.py LANG -d -js

If you modify your script `build_data.py`:

        make.py LANG -b -js