Skip to content

Commit 976dfd0

Browse files
authored
Update README.md
1 parent 2a1c0d6 commit 976dfd0

File tree

1 file changed

+37
-34
lines changed

1 file changed

+37
-34
lines changed

README.md

Lines changed: 37 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,45 @@ 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-
Installation
8-
------------
7+
Building
8+
--------
99

10-
Download one of the [pre-built releases](https://github.com/chinmaygarde/doxygen2docset/releases) for supported platforms or [build locally](#building-locally).
10+
Requirements: A C++ 14 compiler and CMake.
1111

12-
Usage
13-
-----
14-
First, generate Doxygen documentation with the `GENERATE_DOCSET` option enabled.
15-
Then generate the Docset with:
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`.
26+
27+
Preparing Project Doxyfile for Docsets
28+
--------------------------------------
29+
30+
* In the `Doxyfile` for your project, make sure the following options are set:
31+
* `GENERATE_DOCSET = YES`
32+
* `GENERATE_HTML = YES`
33+
* For more thorough instructions on configuring Doxygen. See this reference
34+
https://kapeli.com/docsets#doxygen.
35+
* Invoke `doxygen` to generate HTML documentation. On a successful invocation
36+
of doxygen with the required flags, the html/ directory should be generated.
37+
* This tool depends on reading the following files generated by Doxygen. If
38+
these files are absent, the docset cannot be generated.
39+
* `Tokens.xml`
40+
* `Info.plist`
41+
42+
Generating Docset
43+
-----------------
44+
45+
Generate the Docset from the Doxygen generated docs using:
1646

1747
```
1848
doxgen2docset --doxygen <path to doxygen source> --docset <path to docset dir> [--help]
@@ -38,30 +68,3 @@ Options
3868
3969
--help Print this documentation.
4070
```
41-
42-
Preparing Doxygen for Docsets
43-
-----------------------------
44-
45-
* In the Doxyfile for your project, make sure the following options are set:
46-
* `GENERATE_DOCSET = YES`
47-
* `GENERATE_HTML = YES`
48-
* For more thorough instructions on configuring Doxygen. See this reference
49-
https://kapeli.com/docsets#doxygen.
50-
* Invoke Doxygen to generate HTML documentation. On a successful invocation
51-
of doxygen with the required flags, the html/ directory should be generated.
52-
* This tool depends on reading the following files generated by Doxygen. If
53-
these files are absent, the docset cannot be generated.
54-
* `Tokens.xml`
55-
* `Info.plist`
56-
57-
58-
Building the Tool Locally
59-
-------------------------
60-
61-
Requirements: Mac or Linux Host, Clang or GCC (C++ 14 capable), and, CMake.
62-
63-
* Make sure to pull submodules: `git submodule update --init --recursive`.
64-
* Create the build directory: `mkdir build/`.
65-
* Invoke CMake and build. `cd build/ && cmake ../ && make`.
66-
* The executable is present in `./build/source/doxygen2docset`.
67-
* The unit-test target is present in `./build/tests/doxygen2docset_unittests`.

0 commit comments

Comments
 (0)