-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
fff0b9d
commit f0773f1
Showing
2 changed files
with
5 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,15 @@ | ||
# C Container Collection (CCC) | ||
|
||
This repository contains various data structures written to support C programmers across many disciplines. This library is a byproduct of working with the `pintOS` operating system at Stanford University. It is designed around giving the programmer maximum control over their memory; specifically this library is focussed on giving the programmer maximum control over how and when memory is allocated and deallocated. | ||
The C Container Collection offers a variety of containers for C programmers who want fine-grained control of memory in their programs. All containers offer both allocating and non-allocating interfaces. This means it is possible to write a program in which a container never allocates or frees a single byte of your memory. For the motivations of why such a library is helpful in C read on. | ||
|
||
## Installation | ||
|
||
Currently, this library supports a manual installation via CMake. See the [INSTALL.md](/INSTALL.md) file for more details. | ||
|
||
## Quick Start | ||
|
||
Read the documentation [HERE](https://agl-alexglopez.github.io/ccc). | ||
Read the documentation [HERE](https://agl-alexglopez.github.io/ccc). If you want to dive in right away, it may be best to start with [`types.h`](https://agl-alexglopez.github.io/ccc/files.html) to acquaint yourself with the `ccc_alloc_fn` abstraction and decide if you need allocating or non-allocating containers in your project. | ||
|
||
## About | ||
|
||
These containers are functional, but still a work in progress. A release version is not yet ready. All containers provided by this library can be viewed in the [`ccc/`](/ccc/) folder. More details on usage and design of the library is coming soon. | ||
## Design | ||
|
||
`WIP` |