readme 1.46 KB
Newer Older
Ludovic Apvrille's avatar
Ludovic Apvrille committed
1
For users of TTool: (e.g., for users having a read-only access to the git)
2
------------------- 
3

Ludovic Apvrille's avatar
Ludovic Apvrille committed
4
You can clone the repository, and compile TTool as explained in the developer section below.
Ludovic Apvrille's avatar
Ludovic Apvrille committed
5
For more information: http://ttool.telecom-paristech.fr
6

Ludovic Apvrille's avatar
Ludovic Apvrille committed
7 8
Beware, if you want to use other options of TTool, please, start it with the needed command line, 
or make your own ttool.exe. See the online documentation for more information
Ludovic Apvrille's avatar
Ludovic Apvrille committed
9

10

Ludovic Apvrille's avatar
Ludovic Apvrille committed
11
For developers: (rw access to the git)
12 13
---------------

Ludovic Apvrille's avatar
Ludovic Apvrille committed
14 15 16 17
* Compiling the latest version of TTool:
make ttool

* Compiling the latest version of TTool + companions software:
Ludovic Apvrille's avatar
Ludovic Apvrille committed
18
make all
19

Ludovic Apvrille's avatar
Ludovic Apvrille committed
20 21 22
If the compilation fails with the following error: 'unmappable character for encoding ASCII', you need to do, before the compilation process:
export JAVA_TOOL_OPTIONS=-Dfile.encoding=UTF8

Ludovic Apvrille's avatar
Ludovic Apvrille committed
23 24 25 26 27
Alternatively, if you wish to compile TTool without running tests (tests can be long to run), do:
make ttoolnotest
or
gradle build -x test

28 29 30 31 32
* Installing TTool once compiled
make install

This installs all necessary files in bin/

Ludovic Apvrille's avatar
Ludovic Apvrille committed
33

Ludovic Apvrille's avatar
Ludovic Apvrille committed
34
* Generating a release:
35
make release
Ludovic Apvrille's avatar
Ludovic Apvrille committed
36

Ludovic Apvrille's avatar
Ludovic Apvrille committed
37 38 39
* Starting TTool from the git clone
You should not modify bin/config.xml. Create your own config.xml (e.g. myconfig.xml), and create your own "ttool.exe" file (e.g., myttool.exe) 
if you need to modify the config.xml file
Ludovic Apvrille's avatar
Ludovic Apvrille committed
40 41 42 43 44 45 46 47 48 49 50 51
-> proceed as follows:
$ cp ttool.exe myttool.exe
$ cp bin/config.xml bin/myconfig.xml

Then edit myttool.exe and replace config.xml with myconfig.xml

You can now start TTool:
$ ./myttool.exe


Enjoy!!

Ludovic Apvrille's avatar
Ludovic Apvrille committed
52 53


Ludovic Apvrille's avatar
Ludovic Apvrille committed
54