Skip to content

Commit 5b0db09

Browse files
committed
Add installation methods to README.md
1 parent 83b8440 commit 5b0db09

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,18 @@ The Bookmark file is stored in `json` format.
1616
**More features ?**
1717
Yes, more features are on the way. Some planned ones are, copy to clipboard, modify bookmarks and so on.
1818

19+
## Installation
20+
`rbmenu` is available on [crates.io](https://crates.io/crates/rbmenu)
21+
22+
**Arch Linux** : Available on AUR, `rbmenu` for manual compilation from release and `rbmenu-bin` for precompiled binary
23+
24+
**Manual Installation**
25+
- Install the rust toolchain. `cargo` should be on the `$PATH`
26+
- Clone the repo: `git clone https://github.com/DevHyperCoder/rbmenu.git`. Change directory (`cd`) into the `rbmenu` folder
27+
- Build the code: `cargo build --release`
28+
- Copy the binary to a location on $PATH. Binary is in `./target/release/rbmenu`
29+
- For operation with cargo, `cargo run -- <options>`.
30+
1931
## CLI - Options
2032

2133
| Option / Flags | Description |

0 commit comments

Comments
 (0)