Initial commit

README.md

@@ -0,0 +1,28 @@
+# mem    
+
+## Description
+Simple memory allocator written in C.
+
+## Table of Contents
+
+- [Description](#description)
+- [Features](#features) 
+- [Usage](#usage)
+- [Credits / Resources](#credits--resources)
+- [License](#license)
+
+## Features / TODOS
+- [x] Try / Catch 
+- [x] Versatile Error Handling
+
+## Usage
+`make` to build.<br>
+`make test` to build and run tests. ASAN allocator may fail option is turned on to showcase failure handling.<br>
+
+## Credits / Resources
+[Memory Allocation Strategies - Ginger Bill](https://www.gingerbill.org/series/memory-allocation-strategies/)<br>
+[Arena allocator tips and tricks - Chris Wellons](https://nullprogram.com/blog/2023/09/27/)<br>
+[C Interfaces and Implementations](https://github.com/drh/cii)<br>
+
+## License
+This project is licensed under MIT - see the [LICENSE](LICENSE) file for details.