Grammalecte  Check-in [4eec89895d]

Overview
Comment:[doc] build.md update
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk | doc
Files: files | file ages | folders
SHA3-256: 4eec89895d40427c384ef86a82291ad7f5ec7054f0482d8c5013bcfae56f806f
User & Date: olr on 2017-06-05 20:09:17
Other Links: manifest | tags
Context
2017-06-06
03:38
[doc] update title of build.md check-in: 1e6e86a24a user: olr tags: trunk, doc, v0.5.17
2017-06-05
20:09
[doc] build.md update check-in: 4eec89895d user: olr tags: trunk, doc
19:52
[doc] build.md update check-in: 748b424c33 user: olr tags: trunk, doc
Changes

Modified doc/build.md from [5b95c91eae] to [e911cbaf8c].

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20




21
22

23
24
25
26
27

28
29

30
31
32
33
34



35
36
37



38
39
40
41




42
43
44



45
46
47



48
49
50
51




52
53
54



55
56
57
58
59


60
61
62


63
64
65


66
67
68


69

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16



17
18
19
20
21

22
23
24
25


26
27

28
29
30
31


32
33
34
35


36
37
38
39



40
41
42
43
44


45
46
47
48


49
50
51
52



53
54
55
56
57


58
59
60
61
62
63
64

65
66
67
68

69
70
71
72

73
74
75
76

77
78
79
-
















-
-
-
+
+
+
+

-
+



-
-
+

-
+



-
-
+
+
+

-
-
+
+
+

-
-
-
+
+
+
+

-
-
+
+
+

-
-
+
+
+

-
-
-
+
+
+
+

-
-
+
+
+




-
+
+


-
+
+


-
+
+


-
+
+


# How to build

## Required ##

* Python 3.6
* Firefox Nightly
* NodeJS
  * npm
  * jpm
* Thunderbird


## Commands ##

**Build a language**

    make.py LANG
        generate the LibreOffice extension and the package folder.
        LANG is the lang code (ISO 639).
`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`.
> This script uses the file `config.ini` in the folder `gc_lang/LANG`.

**First build**

    Type:
        make.py LANG -js
`make.py LANG -js`

    This command is required to generate all necessary files.
> 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`.
`-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`.
`-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.
`-js --javascript`

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

    -t --tests
        Run unit tests.
`-t --tests`

> Run unit tests.

    -i --install
        Install the LibreOffice extension.
`-i --install`

> Install the LibreOffice extension.

    -fx --firefox
        Launch Firefox Nightly.
        Unit tests can be lanched from Firefox, with CTRL+SHIFT+F12.
`-fx --firefox`

> Launch Firefox Nightly.
> Unit tests can be lanched from Firefox, with CTRL+SHIFT+F12.

    -tb --thunderbird
        Launch Thunderbird.
`-tb --thunderbird`

> Launch Thunderbird.


## Examples ##

    Full rebuild:
Full rebuild:

        make.py LANG -b -d -js

    After modifying grammar rules:
After modifying grammar rules:

        make.py LANG -t

    If you modify the lexicon:
If you modify the lexicon:

        make.py LANG -d -js

    If you modify your script build_data.py:
If you modify your script `build_data.py`:

        make.py LANG -b -js