| author | nemo |
| Mon, 15 Oct 2018 13:08:29 -0400 | |
| changeset 13941 | 7173b702e8db |
| parent 13517 | b62b14aa88d4 |
| child 13986 | fa9b22311390 |
| permissions | -rw-r--r-- |
|
13517
b62b14aa88d4
Document and clean up tools directory a bit
Wuzzy <Wuzzy2@mail.ru>
parents:
diff
changeset
|
1 |
# tools/ directory |
|
b62b14aa88d4
Document and clean up tools directory a bit
Wuzzy <Wuzzy2@mail.ru>
parents:
diff
changeset
|
2 |
|
|
b62b14aa88d4
Document and clean up tools directory a bit
Wuzzy <Wuzzy2@mail.ru>
parents:
diff
changeset
|
3 |
This directory contains various tools for HW development. |
|
b62b14aa88d4
Document and clean up tools directory a bit
Wuzzy <Wuzzy2@mail.ru>
parents:
diff
changeset
|
4 |
|
|
b62b14aa88d4
Document and clean up tools directory a bit
Wuzzy <Wuzzy2@mail.ru>
parents:
diff
changeset
|
5 |
To learn more about each individual tool, open its source file in a text editor, |
|
b62b14aa88d4
Document and clean up tools directory a bit
Wuzzy <Wuzzy2@mail.ru>
parents:
diff
changeset
|
6 |
it often contains a brief comment at the top. |
|
b62b14aa88d4
Document and clean up tools directory a bit
Wuzzy <Wuzzy2@mail.ru>
parents:
diff
changeset
|
7 |
|
|
b62b14aa88d4
Document and clean up tools directory a bit
Wuzzy <Wuzzy2@mail.ru>
parents:
diff
changeset
|
8 |
## List of tools (excerpt) |
|
b62b14aa88d4
Document and clean up tools directory a bit
Wuzzy <Wuzzy2@mail.ru>
parents:
diff
changeset
|
9 |
|
|
b62b14aa88d4
Document and clean up tools directory a bit
Wuzzy <Wuzzy2@mail.ru>
parents:
diff
changeset
|
10 |
### Files |
|
b62b14aa88d4
Document and clean up tools directory a bit
Wuzzy <Wuzzy2@mail.ru>
parents:
diff
changeset
|
11 |
* `update_locale_files.sh`: Update locale files |
|
b62b14aa88d4
Document and clean up tools directory a bit
Wuzzy <Wuzzy2@mail.ru>
parents:
diff
changeset
|
12 |
* `hwmap2lua.sh`: Convert HWMAP files to Lua code for usage in missions |
|
b62b14aa88d4
Document and clean up tools directory a bit
Wuzzy <Wuzzy2@mail.ru>
parents:
diff
changeset
|
13 |
* `create_dmg.sh`: Generate a .dmg file (relevant for Mac) |
|
b62b14aa88d4
Document and clean up tools directory a bit
Wuzzy <Wuzzy2@mail.ru>
parents:
diff
changeset
|
14 |
* `dmg_pkg_install.sh`: Downloads and install a .dmg from a URL (relevant for Mac) |
|
b62b14aa88d4
Document and clean up tools directory a bit
Wuzzy <Wuzzy2@mail.ru>
parents:
diff
changeset
|
15 |
* `docgen.sh`: Generate QTfrontend documentation with Doxygen (it's not very good) |
|
b62b14aa88d4
Document and clean up tools directory a bit
Wuzzy <Wuzzy2@mail.ru>
parents:
diff
changeset
|
16 |
|
|
b62b14aa88d4
Document and clean up tools directory a bit
Wuzzy <Wuzzy2@mail.ru>
parents:
diff
changeset
|
17 |
### Directories |
|
b62b14aa88d4
Document and clean up tools directory a bit
Wuzzy <Wuzzy2@mail.ru>
parents:
diff
changeset
|
18 |
* `hwmapconverter`: C++ application to edit HWMAP files in text form |
|
b62b14aa88d4
Document and clean up tools directory a bit
Wuzzy <Wuzzy2@mail.ru>
parents:
diff
changeset
|
19 |
* `pas2c`: Pascal-to-C rewriter. Used when hwengine is built as C application with `BUILD_ENGINE_C=1` |
|
b62b14aa88d4
Document and clean up tools directory a bit
Wuzzy <Wuzzy2@mail.ru>
parents:
diff
changeset
|
20 |
* `old`: Very outdated stuff that needs re-examination and possibly deletion |