From a1a13a96bad970a5d3b8c259a5b4612817766537 Mon Sep 17 00:00:00 2001 From: Madeleine <32415621+SpyHoodle@users.noreply.github.com> Date: Wed, 20 Apr 2022 15:07:08 +0100 Subject: [PATCH] Clean up README and add instructions --- README.md | 28 ++++++++++++++++++++++------ 1 file changed, 22 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index be7889f..53ec180 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,28 @@ # pridefetch -Neofetch clone written in Python with the ability to display pride flags +Python fetch script for showing your favourite pride flags! +Forked from [megabytesofrem/pridefetch](https://github.com/megabytesofrem/pridefetch) ## Examples -### Display a trans flag +#### Display a trans flag `pridefetch -f trans` -### Display either a trans or lesbian flag, with a 50/50 chance -`pridefetch -c trans, lesbian` +#### Display either a trans or lesbian flag, with a 50/50 chance +`pridefetch -c trans,lesbian` -### List all the available flags -`pridefetch -l` \ No newline at end of file +#### List all the available flags +`pridefetch -l` + +## Quickstart +```bash +git clone https://github.com/SpyHoodle/pridefetch.git +cd pridefetch +chmod +x pridefetch +``` +Then, run pridefetch +```bash +./pridefetch +``` +You can also add pridefetch to your `$PATH` to run it anywhere
+```bash +mv pridefetch /usr/bin/ +```