diff -r 60bcc20e6ab0 -r b62b14aa88d4 tools/README.md --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/tools/README.md Thu Jul 19 14:01:57 2018 +0200 @@ -0,0 +1,20 @@ +# tools/ directory + +This directory contains various tools for HW development. + +To learn more about each individual tool, open its source file in a text editor, +it often contains a brief comment at the top. + +## List of tools (excerpt) + +### Files +* `update_locale_files.sh`: Update locale files +* `hwmap2lua.sh`: Convert HWMAP files to Lua code for usage in missions +* `create_dmg.sh`: Generate a .dmg file (relevant for Mac) +* `dmg_pkg_install.sh`: Downloads and install a .dmg from a URL (relevant for Mac) +* `docgen.sh`: Generate QTfrontend documentation with Doxygen (it's not very good) + +### Directories +* `hwmapconverter`: C++ application to edit HWMAP files in text form +* `pas2c`: Pascal-to-C rewriter. Used when hwengine is built as C application with `BUILD_ENGINE_C=1` +* `old`: Very outdated stuff that needs re-examination and possibly deletion