Permalink
Browse files

readme update

  • Loading branch information...
1 parent d6fe55b commit 7a5568c775765431baeec9a921510ebb83ab8f44 @schacon schacon committed Jun 13, 2011
Showing with 22 additions and 10 deletions.
  1. +15 −6 README.md
  2. +7 −4 TODO.txt
View
21 README.md
@@ -6,18 +6,27 @@ I built it to replace the Doxygen generated documentation for the libgit2 projec
# Usage
-Run the `cm` binary and pass it your headers directory.
+Run the `cm` binary and pass it your Docurium config file.
- $ cm doc includes/
+ $ cm doc api.docurium
* generating header based docs
- processing limit.h
- processing recess.h
* output html in docs/
- $ cm doc --branch=gh-pages includes/
- * generating header based docs
- - processing chacon.h
- * output html in gh-pages branch at 3dc12a
+The Docurium config files looks like this:
+
+ {
+ "name": "libgit2",
+ "github": "libgit2/libgit2",
+ "input": "include/git2",
+ "prefix": "git_",
+ "output": "docs",
+ "legacy": {
+ "input": {"src/git": ["v0.1.0"],
+ "src/git2": ["v0.2.0", "v0.3.0"]}
+ }
+ }
# License
View
11 TODO.txt
@@ -1,15 +1,18 @@
TODO
-* switch versions
-
* show versions introduced and signature changes
* links to example usage from example docco'd code
+* write directly to branch
+
+* gem-ize
+
+* add to libgit2 project
+
+
* only update certain tags / HEAD, force full update
* highlight menu item when selected
-* write directly to branch
-

0 comments on commit 7a5568c

Please sign in to comment.