From 71f38dfec44732753f47761174072144065ecb9b Mon Sep 17 00:00:00 2001 From: Solomon <56119766+PoetryInCode@users.noreply.github.com> Date: Wed, 24 Jun 2020 10:25:24 -0400 Subject: [PATCH] update README --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d1974ee..f86d5bd 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,14 @@ To view the flag/help screen run with `-h` or `--help` ## Building -### Linux +### Linux/MacOS -On Linux you can clone the repository and just run `make` inside the cloned directory. No dependencies, only a compiler and Gnu Make. +You can clone the repository and just run `make` inside the cloned directory. No dependencies, only a compiler and Gnu Make. It uses the default compiler +on the system, but you can specify a compiler by changing the value of `cc` in the [Makefile](./Makefile) on the first line + +Run `make install` to install it on the system this will require root + +Run `make uninstall` to remove it from the system this will also require root. ### Windows