Permalink
Browse files

[doc] Add a README.md

  • Loading branch information...
1 parent 2f5a5eb commit c004aed105d1135e4cf64712fa5efee9cb036311 @mmalecki committed Mar 30, 2013
Showing with 11 additions and 0 deletions.
  1. +11 −0 README.md
View
@@ -0,0 +1,11 @@
+# `env`
+A C command line option parser. Named `saneopt`, because, as opposed to `getopt`
+it's actually mostly sane.
+
+## API
+API is documented in [`include/saneopt.h`](https://github.com/mmalecki/saneopt/blob/master/include/saneopt.h)
+and heavily used in tests.
+
+## Usage
+Executing `make` in the project tree results in a `libsaneopt.a` to be created.
+You can link this library statically to your project.

0 comments on commit c004aed

Please sign in to comment.