diff options
Diffstat (limited to 'README.org')
| -rw-r--r-- | README.org | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/README.org b/README.org new file mode 100644 index 0000000..09f796a --- /dev/null +++ b/README.org @@ -0,0 +1,24 @@ +#+title: Uconfig + +Uconfig - Read a Unix config file + +"Uconfig" is supposed to stand for "Micro config", because it is a small +library, but maybe saying that it stands for "Unix config" makes more +sense. Choose your side. + +* Installation + +Run ~make~ to compile and ~make install~ to install the static library and the +header file. + +* Usage + +Include =uconfig.h= in the sources. Then link the programs with =-luconfig=. + +In the code: +- create a Uconfig handle by calling ~uconfig_new~ and passing a Unix + configuration file to read, +- retrieve configuration parameters using ~uconfig_get~, +- finalize by calling ~uconfig_destroy~. + +See the example in the =test= subdirectory. |