You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/modules/ROOT/pages/install.adoc
+1-43
Original file line number
Diff line number
Diff line change
@@ -8,8 +8,6 @@ Binaries are available from our https://github.com/cppalliance/mrdox/releases[Re
8
8
9
9
=== Requirements
10
10
11
-
==== LLVM
12
-
13
11
MrDox depends on a recent version of LLVM.
14
12
15
13
Here are the instructions to clone LLVM version required by this project.
@@ -46,49 +44,9 @@ cmake --build . -j <threads>
46
44
cmake --install .
47
45
----
48
46
49
-
==== fmt
50
-
51
-
MrDox uses the `fmt` library to format its messages. The library can be downloaded from https://vcpkg.io/en/getting-started.html[vcpkg] or installed from https://github.com/fmtlib/fmt[their official repository].
52
-
53
-
When using vcpkg, its toolchain should be provided to the mrdox cmake configure command:
54
-
55
-
[source,bash]
56
-
----
57
-
cmake -B [build directory] -S [path to mrdox] -D CMAKE_TOOLCHAIN_FILE=[path to vcpkg]/scripts/buildsystems/vcpkg.cmake
58
-
----
59
-
60
-
When the `fmt` library has been installed from their official release, the library path should be provided to the mrdox cmake configure command:
61
-
62
-
[source,bash]
63
-
----
64
-
cmake -B [build directory] -S [path to mrdox] -D FMT_ROOT=[path to installed fmt]
65
-
----
66
-
67
-
Alternatively, when neither option is available, the mrdox configure script will attempt to automatically download the `fmt` library during configuration.
68
-
69
-
==== duktape
70
-
71
-
The MrDox templating system uses the duktape JS interpreter for its handlebars templating system. The library can be downloaded from https://vcpkg.io/en/getting-started.html[vcpkg] or installed from https://duktape.org/[their official repository].
72
-
73
-
When using vcpkg, its toolchain should be provided to the mrdox cmake configure command:
74
-
75
-
[source,bash]
76
-
----
77
-
cmake -B [build directory] -S [path to mrdox] -D CMAKE_TOOLCHAIN_FILE=[path to vcpkg]/scripts/buildsystems/vcpkg.cmake
78
-
----
79
-
80
-
When duktape has been installed from their https://github.com/svaarala/duktape/releases/tag/v2.7.0[official release], the duktape source path should be provided to the mrdox cmake configure command:
81
-
82
-
[source,bash]
83
-
----
84
-
cmake -B [build directory] -S [path to mrdox] -D DUKTAPE_SOURCE_ROOT=[path to duktape source]
85
-
----
86
-
87
-
Alternatively, when neither option is available, the mrdox configure script will attempt to automatically download duktape during configuration.
88
-
89
47
=== MrDox
90
48
91
-
Once the LLVM variants and dependencies are available in `/path/to/llvm+clang`, you can download MrDox:
49
+
Once the LLVM variants are available in `/path/to/llvm+clang`, you can download MrDox:
0 commit comments