X-Git-Url: https://git.auder.net/?p=cgds.git;a=blobdiff_plain;f=README.md;h=c7cd81d2cba3d0cd13593e0fc77e463fce268bd0;hp=8728d3e33f2093a82812efad74c7376006bb1917;hb=HEAD;hpb=e97c15c14cd66e75ba0dc54e187ee4dcb5d644c9 diff --git a/README.md b/README.md index 8728d3e..c7cd81d 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,20 @@ -# cgds: C Generic Data Structures library +# cgds: C Generic Data Structures library -Various data structures, from stack to tree, which can contain any data type.

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

+More examples in the unit tests under test/ folder.