diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..0d07854 --- /dev/null +++ b/readme.md @@ -0,0 +1,34 @@ + +# lazysphere + +A terrible busybox/gnu coreutils clone. + +Currently the only supported commands are: +`dd`, `cat`, `yes` + +## How to + +`usage: lazysphere [function [arguments]...]` + +Or you can also link lazysphere to a file of a command name, and that new file will act like a binary of that command! + +## License + +This project is Licensed under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html) + +## Compilation + +ritfetch only runs on systems with `curl` installed + +Make sure to have `gcc` and `make` installed, and then run + +```shell +$ make # compiles the program +$ sudo make install # installs the binary +``` + +If you wish to remove the program, you can run + +```shell +$ sudo make uninstall # removes the binary +```