Commit 513e0fb7 authored by Yoann Blein's avatar Yoann Blein

Document the executable packaging procedure

parent d6bf853c
......@@ -4,8 +4,9 @@ To use them, install Python 3.6+ at: https://www.python.org/downloads/
And optionally install the following packages:
- clang python bindings (required to import modmed.cxx or use traceCmd.py 'tps' command to better understand traces corresponding to C++ tracepoints):
pip install clang
Previously, it is better to install clang via http://releases.llvm.org/download.html LLVM 5.0.2 Pre-built Binaries for windows 32 bit
in order to have the C:\Program Files (x86)\LLVM\bin\libclang.dll into the PATH
- Clang must be installed via http://releases.llvm.org/download.html LLVM Pre-built Binaries.
The version must be same as the python wrapper (`pip show clang`) and have the same architecture as your Python interpreter.
Also make sure that `libclang.dll` (located in `C:\Program Files\LLVM\bin` by default) from the installed LLVM is accessible in the PATH.
- babeltrace and cbor2 (required to work with LTTng traces)
To use 'traceCmd.py' script, look at the command line help:
......@@ -24,4 +25,11 @@ The modmed package mainly contains a trace.py module and optional modules:
- lttng.py to work with traces generated by modmedLog C++ library using LTTng
- incas.py to work with traces generated by commercial C++ InCAS log library
This folder also contains Test_*.py unittest scripts corresponding to the modmed package's modules and traceCmd.py script
\ No newline at end of file
This folder also contains Test_*.py unittest scripts corresponding to the modmed package's modules and traceCmd.py script
Package the script as an executable:
Make sure `pyinstaller` is installed (`pip install pyinstaller`), and use
$ pyinstaller.exe --onefile --add-binary path/to/libclang.dll;. traceCmd.py
to create an executable `traceCmd.exe` in the directory `dist`.
Note that the semicolon must be replaced by a colon on UNIX-like systems.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment