Skip to content

Commit

Permalink
Update Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
meynardc authored Jan 19, 2024
1 parent 36115ac commit c03ecfe
Showing 1 changed file with 30 additions and 15 deletions.
45 changes: 30 additions & 15 deletions MMVII/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,17 @@ Dependencies

Compilation (short), replace N with the number of processor threads:
--------------------

Compile MicMac V1

cd MMVII
(mkdir -p build)
mkdir -p build
cd build
cmake ..
make -j N full (or make -j N full VERBOSE=1 to see compile command line)

Following compilations could be run with:
Following compilations could be run just with:

make -j N


Expand All @@ -26,28 +29,36 @@ Compilation (short), replace N with the number of processor threads:
../bin/MMVII Bench 1


Clean :
Compilation targets :

make clean : delete build products
make distclean : delete build products and generated codes
rm -fr MMVII/build/* : reinitialize the build configuration
all|(none) : build MMVII
full : re-generate files for symbolic calculus and build MMVII
rebuild : distclean + full
clean : delete build products
distclean : delete build products and generated files for symbolic calculus

rm -fr MMVII/build/* : reinitialize the build configuration. cmake needs to be rerun after that

In case of SymDer-related compilation error, re-generate symbder code :
In case of SymDer-related compilation error, re-generate files for symbolic calculus :

make full

Compilation (detail):
--------------------
- You can use `cmake -G Ninja ..` to use Ninja build system instead of the native one. (`sudo apt install ninja-build`)
- Use `cmake --build . -j 8` or `cmake --build . -j 8 -v` instead of make (works with all build systems)
- Use `cmake --build . -j 8 [--target TARGET]` or `cmake --build . -j 8 -v [--target TARGET]` instead of make (works with all build systems)
- Use `cmake --build . --target clean` or `cmake --build . --target distclean`
- Use `ccmake ..` or `cmake-gui ..` to change config option:
- CMAKE_BUILD_TYPE:
. Debug : -g
. RelWithDebInfo : -O3 -g (default)
. Release : -O3 -DNDEBUG
- CMAKE_CXX_COMPILER (advanced mode : 't'):
. Allow to set compiler version and type (g++, clang)

- Debug : -g
- RelWithDebInfo : -O3 -g (default)
- Release : -O3 -DNDEBUG
- CMAKE_CXX_COMPILER (advanced mode : 't'):
- Allow to set compiler version and type (g++, clang)
- vMMVII_BUILD (see bellow):
- ON : enable compilation of vMMVII. Needs Qt >= 5.12.8
- OFF: disable compilation of vMMVII
- You may need to add 'CMAKE_PREFIX_PATH=<Qt dir>' on Windows (ex: c:\Qt\6.6.0\msvc2019_64)

Legacy :
--------
Expand Down Expand Up @@ -108,9 +119,13 @@ vCommand (beta)
There is a GUI tool that can help for writing MMVII command : vMMVII

It will be automatically compiled with MMVII if development package Qt5 (or Qt6) is installed (Ubuntu 22.04: `sudo apt install qtbase5-dev`)
Windows: You may have to add path to Qt

Windows: You may have to add Qt installation path when running cmake configuration :

`cmake .. -D CMAKE_PREFIX_PATH=C:\Qt\6.6.0\msvc2019_64`

Usage: just type "vMMVII" in your working directory.

- Sorry, no documentation yet

- This tool is beta: some MMVII parameters may be misinterpreted or not have the good File Dialog helper.

0 comments on commit c03ecfe

Please sign in to comment.