Initial Commit

README.md

@@ -0,0 +1,57 @@
+# ci2 
+
+## Description
+Inspired by the [book](https://github.com/drh/cii), and others, this is my 
+personal C codebase. I wanted to improve my C and DSA knowledge, and make some 
+useful tools since C doesn't have many language features. This is meant to be
+opinionated, and not necessarily modular. It's not meant to be the best way, 
+but I hope to improve it overtime.  
+ 
+## Table of Contents
+
+- [Description](#description)
+- [Features](#features) 
+- [Usage](#usage)
+- [Credits / Resources](#credits--resources)
+- [License](#license)
+
+## Features / TODOS
+Plan to follow CII book and modify it to my style and use C99.
+
+- [ ] Exceptions
+- [ ] Memory Allocator
+- [ ] Arena Allocator
+- [ ] String Views
+- [ ] Atoms / Quarks 
+- [ ] Linked List
+- [ ] Stacks 
+- [ ] Queues 
+- [ ] Vectors / Dynamic Arrays
+- [ ] CLI Parsing
+- [ ] Opening A Window
+
+Once these are implemented. The focus will then shift to make our code cross 
+platform, along with a simple build process. 
+
+
+## Usage
+`make` to build.
+
+`make test` to build and run tests.
+
+## Credits / Resources
+[Tom Preston-Werner README Driven Development](https://tom.preston-werner.com/2010/08/23/readme-driven-development)<br>
+[Make a README](https://www.makeareadme.com/)<br>
+[Choose a LICENSE](https://choosealicense.com/)<br>
+[C Interfaces and Implementations](https://github.com/drh/cii)<br>
+[Sean Barrett - Advice for Writing Small Programs in C](https://www.youtube.com/watch?v=eAhWIO1Ra6M)<br>
+[Eskil Steenberg - How I Program C](https://www.youtube.com/watch?v=443UNeGrFoM)<br>
+[Handmade Hero](https://www.youtube.com/playlist?list=PLnuhp3Xd9PYTt6svyQPyRO_AAuMWGxPzU)<br>
+[Mr. 4th Programming](https://www.youtube.com/playlist?list=PLT6InxK-XQvNKTyLXk6H6KKy12UYS_KDL)<br>
+[Chris Wellons](https://nullprogram.com/)<br>
+[Ginger Bill](https://www.gingerbill.org/)<br>
+[Tsoding Daily](https://www.youtube.com/@TsodingDaily)<br>
+[Jacob Sorber](https://www.youtube.com/channel/UCwd5VFu4KoJNjkWJZMFJGHQ)<br>
+
+## License
+This project is licensed under MIT - see the [LICENSE](LICENSE) file for details.