aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorlukeflo2024-11-19 16:42:14 +0100
committerlukeflo2024-11-19 16:42:14 +0100
commitc05fb327c70eed7dcbc0caccc745e168e6cba5fb (patch)
treef4edfb82e9d2ef33366b6e4725dbc64321422476 /README.md
parent92fb90dfcd61c00fba2a9c7f297bb818cc860587 (diff)
downloadbibiman-c05fb327c70eed7dcbc0caccc745e168e6cba5fb.tar.gz
bibiman-c05fb327c70eed7dcbc0caccc745e168e6cba5fb.zip
update installation info
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 8 insertions, 8 deletions
diff --git a/README.md b/README.md
index 9f9f0b3..692951d 100644
--- a/README.md
+++ b/README.md
@@ -11,8 +11,14 @@ Here's a small impression how it looks and works:
## Installation
-For now, `bibiman` is only available via Codeberg. You have to build it from
-source yourself using `cargo` and `rustup`:
+You can install `bibiman` directly from `crates.io` using `cargo`:
+
+```bash
+cargo install bibiman
+```
+
+To use the version including the newest commits, you can clone the repo and
+build it from source using `cargo`:
```bash
git clone https://codeberg.org/lukeflo/bibiman
@@ -21,18 +27,12 @@ cd bibiman
# Build the binary to /target/release
cargo build --release
-# optional: create symlink:
-ln -sf /target/release/bibiman ~/.local/bin
-
# OR
# Install the binary to CARGO_HOME/bin which normally is in PATH
cargo install --path=. --locked
```
-If you use the symlink option, you have to make sure that the directory
-containing the symlink is in your `PATH`.
-
## Usage
You need to pass a single `.bib` file as first positional argument: