Skip to content
Browse files

update readme

  • Loading branch information...
1 parent 7a5568c commit 804f5e5012e415c437d08e246cf822818baaed3f @schacon schacon committed Jun 13, 2011
Showing with 7 additions and 1 deletion.
  1. +5 −1 README.md
  2. +2 −0 TODO.txt
View
6 README.md
@@ -2,7 +2,7 @@
Docurium is a lightweight Doxygen replacement. It generates static HTML from the header files of a C project. It is meant to be simple, easy to navigate and git-tag aware. It is only meant to document your public interface, so it only knows about your header files.
-I built it to replace the Doxygen generated documentation for the libgit2 project, so I'm only currently testing it against that. So, it only includes support for features and keywords used in that project currently.
+I built it to replace the Doxygen generated documentation for the libgit2 project, so I'm only currently testing it against that. So, it is only known to include support for features and keywords used in that project currently. If you have a C library project you try this on and something is amiss, please file an issue or better yet, a pull request.
# Usage
@@ -28,6 +28,10 @@ The Docurium config files looks like this:
}
}
+# Contributing
+
+If you want to fix or change something, please fork on GitHub, push your change to a branch named after your change and send me a pull request.
+
# License
MIT, see LICENCE file
View
2 TODO.txt
@@ -4,6 +4,8 @@ TODO
* links to example usage from example docco'd code
+* update title from the config file - nothing project specific in the index.html
+
* write directly to branch

0 comments on commit 804f5e5

Please sign in to comment.
Something went wrong with that request. Please try again.