Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create Makefile and add proper README #1

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
DESTDIR=~/.local/bin/

install:
mkdir -p $(DESTDIR) 2> /dev/null
mkdir -p ~/.cache/redyt/
mkdir -p ~/.config/redyt/
touch ~/.config/redyt/subreddit.txt

cp redyt $(DESTDIR)
chmod 755 $(DESTDIR)redyt
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,22 @@
# redyt
Search reddit with CLI

- You need to create a ~/.cache/redyt/ directory
- Also a ~/.config/redyt/subreddit.txt
## Dependencies
- Dmenu
- jq

here is mine subreddit.txt: http://0x0.st/-rbq.txt

Programs you need are dmenu, jq
## Install and Use

note: Idk how to write readme. if anyone can do it and give me a pull request please
```
git clone https://github.com/Bugswriter/redyt.git
cd redyt
make install
```

The Makefile will create a cache directory: `~/.cache/redyt/` , and a .txt file in `~/.config/redyt/subreddit.txt`

The only setup required is to list the subreddit names you would like to fetch images from in `subreddit.txt`. An
example subreddit.txt file can be found [here](http://0x0.st/-rbq.txt).

Once setup, you'll use `redyt` to fetch images from the selected subreddit at the dmenu prompt.