Simplify installation procedure
[cgds.git] / README.md
index 3ac85d7..342d2d6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,15 +2,19 @@
 
 Various data structures, from stack to tree, which can contain any data type.
 
-### 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);
+## Installation
 
-More examples in the unit tests under test/ folder.
+       make [src]
+       make install
+'src' is Makefile default target.
+
+## Example
 
-### Contact
-benjamin [dot] a [at] mailoo.org
+       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.