Readme update
This commit is contained in:
19
README.md
19
README.md
@@ -1,10 +1,7 @@
|
|||||||
# EG
|
# mem
|
||||||
|
|
||||||
## Description
|
## Description
|
||||||
This repository contains eg or "for example" files. That includes this README and LICENSE.
|
Simple memory allocator with exceptions written in C.
|
||||||
`~/eg`is a $HOME directory for me and is marked as an XDG template folder.
|
|
||||||
This allows you to easily create files from "templates" on a desktop.
|
|
||||||
It also serves as a filepath `~/eg` for scripts and automation.
|
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
@@ -14,16 +11,12 @@ It also serves as a filepath `~/eg` for scripts and automation.
|
|||||||
- [Credits / Resources](#credits--resources)
|
- [Credits / Resources](#credits--resources)
|
||||||
- [License](#license)
|
- [License](#license)
|
||||||
|
|
||||||
## Features
|
## Features / TODOS
|
||||||
+ Easy to copy.
|
- [x] Exceptions to handle OOM however you want.
|
||||||
+ Defaults to revert to.
|
- [x] Try/Catch
|
||||||
+ Templates for easy productivity.
|
- [ ] NEW and NEW0 macros
|
||||||
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
Just copy and paste into your projects.<br>
|
|
||||||
/dev - Files used in development.<br>
|
|
||||||
/dot - Files used in configuration.<br>
|
|
||||||
|
|
||||||
## Credits / Resources
|
## Credits / Resources
|
||||||
[Tom Preston-Werner README Driven Development](https://tom.preston-werner.com/2010/08/23/readme-driven-development)<br>
|
[Tom Preston-Werner README Driven Development](https://tom.preston-werner.com/2010/08/23/readme-driven-development)<br>
|
||||||
|
|||||||
Reference in New Issue
Block a user