Some fixes + improvements (Vector) + code reformatting
[cgds.git] / README.md
index 8728d3e..c7cd81d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,14 +1,20 @@
-# cgds: C Generic Data Structures library</h1>
+# cgds: C Generic Data Structures library
 
-Various data structures, from stack to tree, which can contain any data type.</p>
+Various data structures, from stack to tree, which can contain any data type.
+
+## Installation
+
+  make [src]
+  make install
+'src' is Makefile default target.
 
 ## Example
 
-       Vector v = vector_new(int);
-       vector_push(v, 32);
-       vector_push(v, 42);
-       int a; vector_get(v, 1, a); //a now contains 42
-       vector_set(v, 0, 0); //v[0] now contains 0
-       vector_destroy(v);</code></pre>
+    Vector* v = vector_new(int);
+    vector_push(v, 32);
+    vector_push(v, 42);
+    int a; vector_get(v, 1, a); //a now contains 42
+    vector_set(v, 0, 0); //v[0] now contains 0
+    vector_destroy(v);
 
-More examples in the unit tests under test/ folder.</p>
+More examples in the unit tests under test/ folder.