From: Benjamin Auder Date: Fri, 22 Jul 2016 09:33:53 +0000 (+0200) Subject: change README from html to markdown X-Git-Url: https://git.auder.net/%7B%7B%20asset%28%27mixstore/images/doc/current/img/mini-custom.min.css?a=commitdiff_plain;h=e97c15c14cd66e75ba0dc54e187ee4dcb5d644c9;p=cgds.git change README from html to markdown --- diff --git a/README.html b/README.html deleted file mode 100644 index 96e9a0f..0000000 --- a/README.html +++ /dev/null @@ -1,14 +0,0 @@ -

cgds: C Generic Data Structures library

- -

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);
- -

More examples in the unit tests under test/ folder.

diff --git a/README.md b/README.md new file mode 100644 index 0000000..8728d3e --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# cgds: C Generic Data Structures library + +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); + +More examples in the unit tests under test/ folder.