aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorlukeflo2025-03-02 11:22:37 +0100
committerlukeflo2025-03-02 11:22:37 +0100
commit2e1204e98704e466c3b210f05478d0275ea3ea71 (patch)
tree9751c9eae59b24957e86b8e7d4eabbeec2d78654
parentfb1a9fbc56bc9f4d2ae0c922891e378f77bed750 (diff)
downloadbibiman-2e1204e98704e466c3b210f05478d0275ea3ea71.tar.gz
bibiman-2e1204e98704e466c3b210f05478d0275ea3ea71.zip
update README, new gif, installation hints
-rw-r--r--README.md26
1 files changed, 25 insertions, 1 deletions
diff --git a/README.md b/README.md
index 8a503e8..25fcaf2 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,10 @@
- [Bibiman](#bibiman)
- [TL;DR](#tldr)
- [Installation](#installation)
+ - [Crates.io](#cratesio)
+ - [Cargo (Build from source)](#cargo-build-from-source)
+ - [AUR](#aur)
+ - [Void Linux](#void-linux)
- [Usage](#usage)
- [Configuration](#configuration)
- [Location of Config File](#location-of-config-file)
@@ -36,16 +40,20 @@ database as part of a terminal-based scientific workflow.
Here's a small impression how it looks and works:
-[![bibiman.gif](https://i.postimg.cc/d0Mb9vMY/bibiman.gif)](https://postimg.cc/zyj2JsXt)
+[![bibiman.gif](https://i.postimg.cc/Y0mCNDMg/bibiman.gif)](https://postimg.cc/ct0W0mK4)
## Installation<a name="installation"></a>
+### Crates.io<a name="cratesio"></a>
+
You can install `bibiman` directly from `crates.io` using `cargo`:
```bash
cargo install bibiman
```
+### Cargo (Build from source)<a name="cargo-build-from-source"></a>
+
To use the version including the newest commits, you can clone the repo and
build it from source using `cargo`:
@@ -62,6 +70,22 @@ cargo install --path=. --locked
```
+### AUR<a name="aur"></a>
+
+Thanks to user @matcha its possible to install `bibiman` on Arch-based systems
+via the AUR:
+
+```bash
+yay -S bibiman # or any other AUR helper
+```
+
+### Void Linux<a name="void-linux"></a>
+
+I maintain a [PR](https://github.com/void-linux/void-packages/pull/53803) in the
+official Void package repos and hope it gets merged soon. Until that happens,
+you can easily pull that PR into your local clone of Void packages and build it
+with `xbps-src`.
+
## Usage<a name="usage"></a>
The following arguments are possible: