diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..d84f19a --- /dev/null +++ b/Makefile @@ -0,0 +1,10 @@ +dest_dir=~/.local/bin/ + +install: + mkdir -p $(dest_dir) 2> /dev/null + mkdir -p ~/.cache/redyt/ + mkdir -p ~/.config/redyt/ + touch ~/.config/redyt/subreddit.txt + + cp redyt $(dest_dir) + chmod 755 $(dest_dir)redyt diff --git a/README.md b/README.md index d1c985d..8b43d68 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,25 @@ -# redyt -Search reddit with CLI +## redyt +Redyt is an utility that fetches subreddit's images and allows you to see them in the CLI. -- You need to create a ~/.cache/redyt/ directory -- Also a ~/.config/redyt/subreddit.txt +### Dependencies +* [dmenu](https://tools.suckless.org/dmenu/) +* jq + +If you are on an arch based distribution, just run -here is mine subreddit.txt: http://0x0.st/-rbq.txt +```shell +sudo pacman -S dmenu jq +``` -Programs you need are dmenu, jq +### Installation and use -note: Idk how to write readme. if anyone can do it and give me a pull request please +>NOTE: Ensure you have ~/.local/bin in your path. You can do this by typing `echo $PATH` and searching for that folder. +```shell +git clone https://github.com/Bugswriter/redyt.git +cd redyt +make install +``` +The only thing that is left to do is to write your favourite subreddits in `subreddit.txt` which is placed on `~/.config/redyt/subreddit.txt`. [Here](https://0x0.st/-rbq.txt) is an example of the subreddit.txt file. + +Now, you can use redyt by typing `redyt` in your terminal!