Skip to content

Commit 6ca90e5

Browse files
authored
Update README.md
1 parent 976dfd0 commit 6ca90e5

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

README.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,14 @@ Dash or Zeal Docsets from Doxygen Documentation
44
Converts Doxygen Documentation to a [Dash](https://kapeli.com/dash) or
55
[Zeal](https://zealdocs.org/) Docset.
66

7-
Building
8-
--------
7+
Usage
8+
-----
99

10-
Requirements: A C++ 14 compiler and CMake.
11-
12-
* Make sure to pull submodules.
13-
```sh
14-
git submodule update --init --recursive
15-
```
16-
* Configure the build system.
17-
```sh
18-
cmake -B build
19-
```
20-
* Build the executable and tests.
21-
```sh
22-
cmake --build build
23-
```
24-
* The executable is present in `./build/source/doxygen2docset`.
25-
* The unit-test target is present in `./build/tests/doxygen2docset_unittests`.
10+
* [Prepare your Doxygen docs](#preparing-project-doxyfile-for-docsets).
11+
* Generate the Docset from the Doxygen generated docs using:
12+
```
13+
doxgen2docset --doxygen <path to doxygen source> --docset <path to docset dir> [--help]
14+
```
2615

2716
Preparing Project Doxyfile for Docsets
2817
--------------------------------------
@@ -39,14 +28,25 @@ Preparing Project Doxyfile for Docsets
3928
* `Tokens.xml`
4029
* `Info.plist`
4130

42-
Generating Docset
43-
-----------------
31+
Building
32+
--------
4433

45-
Generate the Docset from the Doxygen generated docs using:
34+
Requirements: A C++ 14 compiler and CMake.
4635

36+
* Make sure to pull submodules.
37+
```sh
38+
git submodule update --init --recursive
39+
```
40+
* Configure the build system.
41+
```sh
42+
cmake -B build
4743
```
48-
doxgen2docset --doxygen <path to doxygen source> --docset <path to docset dir> [--help]
44+
* Build the executable and tests.
45+
```sh
46+
cmake --build build
4947
```
48+
* The executable is present in `./build/source/doxygen2docset`.
49+
* The unit-test target is present in `./build/tests/doxygen2docset_unittests`.
5050

5151
Options
5252
-------

0 commit comments

Comments
 (0)