Update README

diff --git a/README b/README
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..52f465fd2c06a6740e4c3988c7d212a2d73c87a2 100644 (file)
--- a/README
+++ b/README
@@ -0,0 +1,32 @@
+INTRODUCTION
+============
+
+Klib is a standalone and lightweight C library. Currently all components are
+independent of external libraries, except the standard C library, and
+independent of each other. To use a component of this library, you only need to
+copy one or two files to your souce code tree without worrying about library
+dependencies.
+
+
+OVERVIEW
+========
+
+khash.h         Generic hash table
+kbtree.h        Generic B-tree
+ksort.h         Generic sort
+kseq.h          Generic stream buffer plus a FASTA/Q parser
+kvec.h          Generic vector
+klist.h         Generic single-linked list plus a memory pool
+kstring.{h,c}   String library
+knetfile.{h,c}  Random access to remote files
+
+kfunc.c         Special mathematical functions
+kmin.{h,c}      Derivative-free non-linear programming
+khmm.{h,c}      Basic HMM library
+knhx.{h,c}      Newick format parser
+
+
+LICENSE
+=======
+
+Most of the source codes are released under the MIT/X11 or the BSD license.