Skip to content

readme improvements #8

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.

Sign up for GitHub

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

Open
DesjardinsRepos wants to merge 1 commit into
base: main
Choose a base branch
from
Open

readme improvements #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 20 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,31 @@ This script will automatically create the two following folders:
- `~/.config/redyt`

Also, another file, containing the subreddits, will be created:

- `~/.config/redyt/subreddit.txt`
- `~/.config/redyt/subreddits.txt`

It the user does not modify it, it will contain, by default, subreddit `linux`.

However, note that you can either pass a subreddit as an argument (`./redyt [your-subreddit]`)
or, from `dmenu`, type the name of another subreddit.

Here's an example of a custom `subreddit.txt`: http://0x0.st/-rbq.txt
[Here's](http://0x0.st/-rbq.txt) an example of a custom subreddit.txt

Installation
---------

This script needs to have the packages [dmenu](https://wiki.archlinux.org/index.php/dmenu) (User Input), [jq](https://archlinux.org/packages/community/x86_64/jq/) (JSON parsing) and [sxiv](https://wiki.archlinux.org/index.php/sxiv) (Image Previewing) installed to work. [notify-send](https://archlinux.org/packages/community/x86_64/notify-osd/) is recommended but optional. If it isn't present, `echo` will be used as a notifier.

On Arch, just

Please note: you will need to install the following programs:
- dmenu (User Input)
- jq (JSON parsing)
- sxiv (Image Previewing)
cd /download/location/path && sudo pacman -S dmenu jq sxiv notify-osd

`notify-send` is also recommended but, if not present, `echo` will be used as a notifier.
For Debian-based distros you can use

cd /download/location/path && sudo apt install dmenu jq sxiv notify-osd


After that

git clone https://github.com/Bugswriter/redyt.git
cd redyt
sudo make install