change README from html to markdown

[cgds.git] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..8728d3e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# cgds: C Generic Data Structures library</h1>
+
+Various data structures, from stack to tree, which can contain any data type.</p>
+
+## 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>
+
+More examples in the unit tests under test/ folder.</p>