summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorTylo <[email protected]>2020-06-18 12:05:09 +0200
committerTylo <[email protected]>2020-06-18 12:05:09 +0200
commit5a5e98232b6bdf5d8ed139da5378baa0a480e56b (patch)
tree066c1b9e4ad79a42c164d7f47bc8cdd228f6a3c3
parent752f34227717d416f3f36bcdae50324f084e8b6b (diff)
parent928ae4a64d8bc694e7e8c9042cc7b93b77f0420c (diff)
downloadSTC-modified-5a5e98232b6bdf5d8ed139da5378baa0a480e56b.tar.gz
STC-modified-5a5e98232b6bdf5d8ed139da5378baa0a480e56b.zip
Merge branch 'master' of https://github.com/tylo-work/C99Containers
-rw-r--r--README.md17
1 files changed, 9 insertions, 8 deletions
diff --git a/README.md b/README.md
index 46334366..f4276f40 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,15 @@
-# stc
+STC - C99 Standard Container Library
+====================================
Introduction
------------
-A modern, typesafe, very efficient, generic C99 container library: String, Vector and Hashmap
+A modern, generic, typesafe, and very efficient standard container library for C99.
-Headers only library with the most used data structures: string, dynamic vector/stack, and map/assosiative array. The library has an intuitive and API. It uses overloadable macros to simplify usage.
+This is a small headers only library with the most used data structures: **cstring**, **cvector**, **carray**, **clist** and **map**.
Usage
-----
-CString demo:
+CString demo
```
#include <stc/cstring.h>
@@ -34,7 +35,7 @@ int main() {
cstring_destroy(&cs);
}
```
-Simple CVector of 64bit ints:
+Simple CVector of 64bit int
```
#include <stc/cvector.h>
declare_CVector(ix, int64_t); // ix is just an example tag name, use anything without underscore.
@@ -52,7 +53,7 @@ int main() {
cvector_ix_destroy(&bignums);
}
```
-CVector of CString:
+CVector of CString
```
#include <stc/cstring.h>
#include <stc/cvector.h>
@@ -82,7 +83,7 @@ int main() {
cmap_ii_destroy(&nums);
}
```
-Simple CMap, CString -> int:
+Simple CMap, CString -> int
```
#include <stc/cstring.h>
#include <stc/cmap.h>
@@ -106,7 +107,7 @@ int main() {
cmap_si_destroy(&nums);
}
```
-CMap, with CString -> CString. Temporary CString values are created by "make", and moved to the container.
+CMap, with CString -> CString. Temporary CString values are created by "make", and moved to the container
```
#include <stc/cstring.h>
#include <stc/cmap.h>