make readme

make more like make... sorry make more like make...
This commit is contained in:
Minecon724 2024-08-13 15:16:05 +02:00
parent 59a007972e
commit bc47c7c685
Signed by: Minecon724
GPG key ID: 3CCC4D267742C8E8

22
README.md Normal file
View file

@ -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 <input> <output>
```
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)