From c05fb327c70eed7dcbc0caccc745e168e6cba5fb Mon Sep 17 00:00:00 2001 From: lukeflo Date: Tue, 19 Nov 2024 16:42:14 +0100 Subject: update installation info --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) (limited to 'README.md') 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: -- cgit v1.2.3