diff options
Diffstat (limited to 'bin/README.md')
| -rw-r--r-- | bin/README.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/bin/README.md b/bin/README.md new file mode 100644 index 0000000000..88a9b73a49 --- /dev/null +++ b/bin/README.md @@ -0,0 +1,28 @@ +# Tools and Non-Build Scripts + +Tools and scripts mostly not used during the build + +This direction has a number of key pieces (?) that are used during the +build, or are simply generally useful. One example is `bin/run`. + +This utility can be used to run the executables in this folder: + + workdir/LinkTarget/Executable + +Format of the usage is: + + ./bin/run application [parameters]|--list|--help + +Use --list (same as -list or -l) to get the list of executables +Use --help (same as -help or -h) to get this help + +Another example is: + + bin/find-german-comments <directory> + +which will try to detect and extract all the German comments in a +given source code hierarchy `/` directory. + +Please note that the associated issue [tdf#39468](https://bugs.documentfoundation.org/show_bug.cgi?id=39468) is now marked as +RESOLVED/FIXED, so don't expect many German comments. + |