diff --git a/README.md b/README.md new file mode 100644 index 0000000..80c5d5f --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +1. Clone this repo: + ``` + git clone https://git.m724.eu/Minecon724/enhancer + ``` +2. Open `main.c` and take a look at the settings, defaults are fine +3. Compile: (you must do this after every change of settings) + ``` + make + ``` +4. Done, you should see `enhancer` in the main directory + +Usage: +``` +./enhancer +``` + +To build a debug binary: (you don't need this unless you do) +``` +make debug +``` + +Just so I don't forget, I wanted to *make* a *make* sure `make` is installed joke but I rearranged things and it doesn't fit (*make* sense)