Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
chinmaygarde authored Sep 4, 2019
1 parent 2f6a532 commit 28aff4d
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
Doxygen 2 Docsets
=================
Dash or Zeal Docsets from Doxygen Documentation
===============================================

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

Converts Doxygen Documentation to a Dash or Zeal Docset.
Converts Doxygen Documentation to a [Dash](https://kapeli.com/dash) or [Zeal](https://zealdocs.org/) Docset.

Usage
-----

First, generate Doxygen documentation with the `GENERATE_DOCSET` option enabled. Then generate the Docset with:
```
doxgen2docset --doxygen <path to doxygen source> --docset <path to docset dir> [--help]
```
Expand Down

0 comments on commit 28aff4d

Please sign in to comment.