Skip to content

Commit c66cd78

Browse files
committed
Update Readme with installation instructions.
1 parent 28aff4d commit c66cd78

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,18 @@ Dash or Zeal Docsets from Doxygen Documentation
33

44
[![CircleCI](https://circleci.com/gh/chinmaygarde/doxygen2docset.svg?style=svg)](https://circleci.com/gh/chinmaygarde/doxygen2docset)
55

6-
Converts Doxygen Documentation to a [Dash](https://kapeli.com/dash) or [Zeal](https://zealdocs.org/) Docset.
6+
Converts Doxygen Documentation to a [Dash](https://kapeli.com/dash) or
7+
[Zeal](https://zealdocs.org/) Docset.
8+
9+
Installation
10+
------------
11+
12+
Download one of the [pre-built releases](https://github.com/chinmaygarde/doxygen2docset/releases) for supported platforms or [build locally](#building-locally).
713

814
Usage
915
-----
10-
First, generate Doxygen documentation with the `GENERATE_DOCSET` option enabled. Then generate the Docset with:
16+
First, generate Doxygen documentation with the `GENERATE_DOCSET` option enabled.
17+
Then generate the Docset with:
1118
```
1219
doxgen2docset --doxygen <path to doxygen source> --docset <path to docset dir> [--help]
1320
```

0 commit comments

Comments
 (0)