v0.26.0

documentation/.gitignore

@@ -1 +1 @@
-book
+book

documentation/Overview/files_overview.md

@@ -1,32 +0,0 @@
-# Files Overview
-
-An overview of the source files (all `.h`) of the C Macro Collections library.
-
-* `./cmc` - The main C Macro Collections library
-    * `./bidimap.h` - A bi-directional map based on a hash table
-    * `./deque.h` - A double-ended queue
-    * `./hashmap.h` - A map based on a hash table
-    * `./hashset.h` - A set based on a hash table
-    * `./heap.h` - A binary heap based on a dynamic array
-    * `./intervalheap.h` - A heap that is both Min and Max based on a dynamic array
-    * `./linkedlist.h` - A doubly-linked list
-    * `./list.h` - A dynamic array
-    * `./multimap.h` - A map that accepts multiple keys based on a hash table
-    * `./multiset.h` - A multiset based on a hash table
-    * `./queue.h` - A FIFO based on a circular dynamic array
-    * `./sortedlist.h` - A sorted list based on a dynamic array
-    * `./stack.h` - A LIFO based on a dynamic array
-    * `./treemap.h` - A sorted map based on an AVL tree
-    * `./treeset.h` - A sorted set based on an AVL tree
-* `./cor` - Core functionalities of the C Macro Collections libraries
-    * `./core.h` - Core functionalities of the library
-    * `./hashtable.h` - Common things used by hash table based collections
-* `./dev` - A mirror of the main library to be used during development
-* `./sac` - Statically Allocated Collections that don't use dynamic allocation
-* `./utl` - Utilities
-    * `./assert.h` - Non-abortive assert macros
-    * `./foreach.h` - For Each macros
-    * `./futils.h` - Common functions used by Functions Table
-    * `./log.h` - Logging utility with levels of severity
-    * `./test.h` - Simple Unit Test building with macros
-    * `./test.h` - Timing code execution utility

documentation/book.toml

@@ -0,0 +1,6 @@
+[book]
+authors = ["Leonardo Vencovsky"]
+language = "en"
+multilingual = false
+src = "src"
+title = "CMC Docs"

documentation/src/Introduction/introduction.md

@@ -4,7 +4,7 @@
     <img src="img/logo.png" alt="C Macro Collections Logo" width="300"/>
 </p>
 
-<p align="center">Header only, macro generated, generic and type-safe Collections in C.</p>
+<p align="center">Easy to use, modular, header only, macro based, generic and type-safe Data Structures in C</p>
 
 <p align="center">
     <a href="https://github.com/LeoVen/C-Macro-Collections"><img src="https://img.shields.io/badge/GitHub-C%20Macro%20Collections-2195F3.svg?logo=github" alt="LinkToRepo"/></a>
@@ -13,10 +13,16 @@
 
 <p align="center">
     <a href="https://github.com/LeoVen/C-Macro-Collections/blob/master/LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License"/></a>
-    <img src="https://img.shields.io/badge/Version-v0.23.1-orange.svg" alt="Version"/>
+    <a href="https://github.com/LeoVen/C-Macro-Collections/releases"><img src="https://img.shields.io/badge/Version-v0.26.0-orange.svg" alt="Version"/></a>
     <a href="https://travis-ci.org/LeoVen/C-Macro-Collections"><img src="https://travis-ci.org/LeoVen/C-Macro-Collections.svg?branch=master" alt="travis-ci"/></a>
     <a href="https://codecov.io/gh/LeoVen/C-Macro-Collections"><img src="https://codecov.io/gh/LeoVen/C-Macro-Collections/branch/master/graph/badge.svg" alt="codecov"/></a>
-    <img src="https://github.com/LeoVen/C-Macro-Collections/workflows/Test%20Suit/badge.svg?branch=master" alt="test_suit"/>
+    <a href="https://github.com/LeoVen/C-Macro-Collections/actions"><img src="https://github.com/LeoVen/C-Macro-Collections/workflows/Test%20Suit/badge.svg?branch=master" alt="test_suit"/></a>
+</p>
+
+<p align="center">
+    <a href="https://github.com/LeoVen/C-Macro-Collections/stargazers"><img src="https://img.shields.io/github/stars/LeoVen/C-Macro-Collections?style=flat&color=ffa000" alt="Stars"/></a>
+    <a href="https://github.com/XAMPPRocky/tokei"><img src="https://img.shields.io/badge/Lines%20of%20Code-28513-007596.svg" alt="loc"/></a>
+    <a href="https://github.com/XAMPPRocky/tokei"><img src="https://img.shields.io/badge/Files-130-961c00.svg" alt="loc"/></a>
 </p>
 
 The C Macro Collections Library is a compilation of macros that can be used to generate common data structures for any desired type. These data structures are [type safe](https://en.wikipedia.org/wiki/Type_safety) and are powered with many features (see Features section).

documentation/src/Overview/files_overview.md

@@ -0,0 +1,30 @@
+# Files Overview
+
+An overview of the source files (all `.h`) of the C Macro Collections library.
+
+* `cmc` - The main C Macro Collections library
+* `cor` - Core functionalities of the C Macro Collections libraries
+    * `core.h` - Core functionalities of the library
+    * `hashtable.h` - Common things used by hash table based collections
+* `utl` - Utilities
+    * `assert.h` - Non-abortive assert macros
+    * `foreach.h` - For Each macros
+    * `futils.h` - Common functions used by Functions Table
+    * `log.h` - Logging utility with levels of severity
+    * `test.h` - Simple Unit Test building with macros
+    * `test.h` - Timing code execution utility
+* `bidimap.h` - A bi-directional map based on a hash table
+* `deque.h` - A double-ended queue
+* `hashmap.h` - A map based on a hash table
+* `hashset.h` - A set based on a hash table
+* `heap.h` - A binary heap based on a dynamic array
+* `intervalheap.h` - A heap that is both Min and Max based on a dynamic array
+* `linkedlist.h` - A doubly-linked list
+* `list.h` - A dynamic array
+* `multimap.h` - A map that accepts multiple keys based on a hash table
+* `multiset.h` - A multiset based on a hash table
+* `queue.h` - A FIFO based on a circular dynamic array
+* `sortedlist.h` - A sorted list based on a dynamic array
+* `stack.h` - A LIFO based on a dynamic array
+* `treemap.h` - A sorted map based on an AVL tree
+* `treeset.h` - A sorted set based on an AVL tree

documentation/src/chapter_1.md

@@ -0,0 +1 @@
+# Chapter 1