diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..91c229a --- /dev/null +++ b/readme.md @@ -0,0 +1,43 @@ + +# ritfetch + +A fetch command that can get club information + +## How to + +`usage: ritfetch domain` + +ritfetch needs a `domain` to get data from its `.well-known/ritfetch` directory. + +### Setting up a domain + +To setup a domain for ritfetch create two files in `.well-known/ritfetch` + +#### logo + +Make a file called `logo` that is just ascii a image. This is to be printed just like your linux distro icon on a linux system. Also the file needs to have its anscii escape code within it such that when you curl the file, what is printed is what you will see. + +#### data + +Make a file called `data` that contains the colors, spacing, and data for the fetch. The first line is a number containing the offset which the data will be shown from the logo. The 2nd two numbers are the anscii escape code colors (without the [ and the m) for the accent highlight color and normal text color. Finally the rest of the lines will just be a line for the key and then a line for the value, for all the content shown in the fetch. + +## 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 +```