File tree 1 file changed +2
-43
lines changed
1 file changed +2
-43
lines changed Original file line number Diff line number Diff line change 1
1
= MrDocs
2
2
3
- == Install
3
+ image::docs/modules/ROOT/images/MrDocsBanner.jpg[Mr. Docs Documentation,link=https://www.mrdocs.com]
4
4
5
- This library depends on a recent version of LLVM.
6
- Here are the instructions to install LLVM with the settings required by this project.
5
+ Visit the Mr. Docs Documentation website at https://www.mrdocs.com.
7
6
8
- [source,bash]
9
- ----
10
- git clone https://github.com/llvm/llvm-project.git
11
- cd llvm-project
12
- git checkout 7a28a5b3fee6c78ad59af79a3d03c00db153c49f
13
- cmake -S llvm -B build -D LLVM_ENABLE_PROJECTS="clang;clang-tools-extra" -D CMAKE_BUILD_TYPE=Release -D LLVM_ENABLE_RTTI=ON -D CMAKE_INSTALL_PREFIX=/path/to/llvm+clang
14
- cd build
15
- cmake --build . -j <threads> --config Release
16
- cmake --install .
17
- ----
18
-
19
- Once LLVM is available in `/path/to/llvm+clang`, you can build and install mrdocs with:
20
-
21
- [source,bash]
22
- ----
23
- git clone https://github.com/cppalliance/mrdocs
24
- cd mrdocs
25
- cmake -S . -B build -D CMAKE_BUILD_TYPE=Release -D LLVM_ROOT=/path/to/llvm+clang -D Clang_ROOT=/path/to/llvm+clang
26
- cd build
27
- cmake --build . -j <threads>
28
- cmake --install .
29
- ----
30
-
31
- == Comparison
32
-
33
- === Doxygen:
34
-
35
- * Tries to work for many languages
36
- * Uses the inferior libclang API
37
- * Old program with lots of technical debt
38
- * Not written by me
39
-
40
- === MrDocs:
41
-
42
- * Narrow and deep focus on {cpp} only
43
- * Uses clang's unstable libtooling API:
44
- ** Understands ALL C++: if clang can compile it, MrDocs knows about it
45
- ** This includes up to {cpp}20 and even experimental features in {cpp}23
46
- * Brand-new program with no technical debt
47
- * Written by me
48
7
49
8
You can’t perform that action at this time.
0 commit comments