📖 Improve installation documentation
Switched sections for dependencies and installation around and created better sub-headings. Added section on installing packaged AUR version, thanks to @firegem for packaging it! Fixed some whitespace on line endings. Closes #6.
This commit is contained in:
parent
f791bf093c
commit
edd5ebd743
1 changed files with 29 additions and 20 deletions
27
README.md
27
README.md
|
@ -1,4 +1,4 @@
|
||||||
# bemoji ❤ - Quickly ⛏ your 🌟
|
# bemoji ❤️ - Quickly ⛏️ your 🌟
|
||||||
|
|
||||||
![bemoji picker interface on bemenu](assets/bemenu.png)
|
![bemoji picker interface on bemenu](assets/bemenu.png)
|
||||||
|
|
||||||
|
@ -8,8 +8,20 @@ Will remember your favorite emojis and give you quick access.
|
||||||
|
|
||||||
## 📁 Installation
|
## 📁 Installation
|
||||||
|
|
||||||
|
### Dependencies
|
||||||
|
|
||||||
|
* One of `bemenu`, `wofi`, `rofi`, `dmenu`, or supplying your own picker.
|
||||||
|
* One of `wl-copy`, `xclip`, `xsel` or supplying your own clipboard tool.
|
||||||
|
* One of `wtype`, `xdotool` or supplying your own typing tool.
|
||||||
|
* `sed`, `grep`, `cut`, `sort`, `uniq`, `tr`, `curl` if using the download functionality.
|
||||||
|
|
||||||
|
To see how to substitute the default choices with your own tools,
|
||||||
|
see Options below.
|
||||||
|
|
||||||
![rofi picker interface](assets/rofi.png)
|
![rofi picker interface](assets/rofi.png)
|
||||||
|
|
||||||
|
### Manual
|
||||||
|
|
||||||
Option 1. Clone the repository and put the executable somewhere in your path:
|
Option 1. Clone the repository and put the executable somewhere in your path:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
@ -27,16 +39,13 @@ chmod +x bemoji/bemoji
|
||||||
ln -s bemoji/bemoji /usr/local/bin/bemoji
|
ln -s bemoji/bemoji /usr/local/bin/bemoji
|
||||||
```
|
```
|
||||||
|
|
||||||
Dependencies:
|
### Arch Linux
|
||||||
|
|
||||||
* One of `bemenu`, `wofi`, `rofi`, `dmenu`, or supplying your own picker.
|
On Arch Linux, bemoji has been packaged for the [AUR](https://aur.archlinux.org/packages/bemoji-git) so it can be installed manually from here or easily with your preferred AUR helper, e.g.:
|
||||||
* One of `wl-copy`, `xclip`, `xsel` or supplying your own clipboard tool.
|
|
||||||
* One of `wtype`, `xdotool` or supplying your own typing tool.
|
|
||||||
* `sed`, `grep`, `cut`, `sort`, `uniq`, `tr`, `curl` if using the download functionality.
|
|
||||||
|
|
||||||
To see how to substitute the default choices with your own tools,
|
|
||||||
see Options below.
|
|
||||||
|
|
||||||
|
```bash
|
||||||
|
paru -S bemoji-git
|
||||||
|
```
|
||||||
|
|
||||||
## 💿 Usage
|
## 💿 Usage
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue