@@ -26,30 +26,30 @@ installed via Python's pip. For more info, see
2626https://mesonbuild.com
2727
2828
29- To build the library,
29+ To build the library::
30+
31+ $> cd <repository>
32+ $> meson mbuild --buildtype=release
33+ $> cd mbuild
34+ $> ninja
3035
31- $> cd <repository>
32- $> meson mbuild --buildtype=release
33- $> cd mbuild
34- $> ninja
35-
3636This will compile with optimization and without debug symbols. Other
37- possibilities are --buildtype=debug and --buildtype=debugoptimized
37+ possibilities are ` --buildtype=debug ` and ` --buildtype=debugoptimized `
3838To use a different compiler, e.g. clang, prefix the meson command
39- with CC=clang CXX=clang++.
39+ with ` CC=clang CXX=clang++ ` .
4040See https://mesonbuild.com/Running-Meson.html for general Meson usage.
4141
4242
4343Installing
4444----------
4545
46- To install the library systemwide,
46+ To install the library systemwide::
47+
48+ $> ninja install
4749
48- $> ninja install
49-
50- To install in a user-defined location
50+ To install in a user-defined location::
5151
52- $> DESTDIR=<prefix absolute path> ninja install
52+ $> DESTDIR=<prefix absolute path> ninja install
5353
5454
5555Using the Library
@@ -63,65 +63,62 @@ with `libRePrimAnd`.
6363Creating Documentation
6464----------------------
6565
66- To just build the documentation, use the target `documentation`.
66+ To just build the documentation, use the target `documentation `::
6767
68- $> ninja documentation
68+ $> ninja documentation
6969
7070The resulting pages can be found in the build directory under
71- docsrc/sphinx/index.html
71+ ` docsrc/sphinx/index.html `
7272When installing the library, the documentation is installed as well
73- by default, to <prefix>/usr/local/share/doc/libreprimand/index.html
73+ by default, to ` <prefix>/usr/local/share/doc/libreprimand/index.html `
7474
7575The building of the documentation requires sphinx with the breathe
7676extension as well as doxygen. To disable building documentation and
77- remove the corresponding dependencies, use the build option
77+ remove the corresponding dependencies, use the build option::
7878
79- $> cd <repository>/mbuild
80- $> meson configure -Dbuild_documentation=false
79+ $> cd <repository>/mbuild
80+ $> meson configure -Dbuild_documentation=false
8181
8282
8383Running Tests
8484-------------
8585
8686Please also take a minute to run the unit tests to ensure
87- correct compilation
87+ correct compilation::
88+
89+ $> ninja test
8890
89- $> ninja test
90-
9191
9292Benchmarks
9393----------
9494
9595The repository contains code to map the efficiency and accuracy of
9696the primitive recovery, producing the plots shown in the
97- article. To recreate the data and plots,
97+ article. To recreate the data and plots::
9898
99+ $> ninja benchplots
100+ $> ninja accuracyplots
99101
100- $> ninja benchplots
101- $> ninja accuracyplots
102-
103102The resulting pdf figures are placed in the build directory under
104103tests/benchmarks
105104
106105This requires Python+matplotlib. To disable building benchmarking and
107- remove the corresponding dependencies, use the build option
108-
109- $> cd <repository>/mbuild
110- $> meson configure -Dbuild_benchmarks=false
106+ remove the corresponding dependencies, use the build option::
111107
108+ $> cd <repository>/mbuild
109+ $> meson configure -Dbuild_benchmarks=false
112110
113111Visualizing Master Function
114112---------------------------
115113
116114In addition, there is code to sample the primitive recovery master
117115function (the central ingredient of the scheme) for various cases,
118- as shown in the paper.
116+ as shown in the paper::
119117
118+ $> ninja srootdata
120119
121- $> ninja srootdata
122-
123120The resulting data files are placed in the build directory under
124- tests/sample_root/
121+ ` tests/sample_root/ `
125122
126123
127124
0 commit comments