This commit is contained in:
Leonardo committed 2019-06-21 16:17:11 -03:00
1 parent 8010cce8c7
commit 6213b42d5a
1 file changed
+22 -16
+22 -16
View File
@@ -3,11 +3,27 @@
Generate Simple Data Structures of any type in C for you to use in your projects.
![License](https://img.shields.io/badge/License-MIT-blue.svg)
![Version](https://img.shields.io/badge/Version-v1.4.3-orange.svg)
![Version](https://img.shields.io/badge/Version-v1.5.0-orange.svg)
![Build](https://travis-ci.org/LeoVen/C-Macro-Collections.svg?branch=master)
## Project Structure
* __benchmarks__ - Where all benchmarks are hosted
* __examples__ - Examples separated by collections
* __src__ - All headers part of the C Macro Collections Library
* __cmc__ - The main C Macro Collections Library
* __dev__ - The main C Macro Collections Library for development (containing logging)
* __ext__ - Extra collections
* __sac__ - Stack Allocated Collections
* __utl__ - Utility like ForEach macros, logging, etc
* __macro\_collections.h__ - Master header containing all collections and utilities
* __tests__ - Where all tests are hosted
Only Collections located in __cmc__ are to be documented at *Documentation.md*.
## Available Collections
* Main C Macro Collections Library
* Deque
* HashMap
* HashSet
@@ -18,8 +34,12 @@ Generate Simple Data Structures of any type in C for you to use in your projects
* Stack
* TreeMap
* TreeSet
* Extra Collections Library
* LinkedQueue
* Stack Allocated Collections Library
* Stack
### Available Collections in future updates
### More to Come
* MultiMap
* MultiSet
@@ -29,20 +49,6 @@ Generate Simple Data Structures of any type in C for you to use in your projects
Check out **Documentation.md** for more information about each collection.
## Project Structure
* __benchmarks__ - Where all benchmarks are hosted
* __src__ - All headers part of the C Macro Collections Library
* __cmc__ - The main C Macro Collections Library
* __dev__ - The main C Macro Collections Library for development (containing logging)
* __ext__ - Extra collections
* __sac__ - Stack Allocated Collections
* __utl__ - Utility like ForEach macros, logging, etc
* __macro\_collections.h__ - Master header containing all collections and utilities
* __tests__ - Where all tests are hosted
Only Collections located in __cmc__ are to be documented at Documentation.md.
## Design Decisions
### Stack vs Heap Allocation