Skip to content

Commit d060e68

Browse files
senekorcgwalters
authored andcommitted
Improve installation instructions
Since cargo can install from git repository URLs directly, a separate `git clone` step is unnecessary. Reference the detailed installation page from the readme to avoid duplication and inconsistencies. Signed-off-by: Remo Senekowitsch <remo@buenzli.dev>
1 parent 44eb365 commit d060e68

2 files changed

Lines changed: 7 additions & 8 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ disk images that can be imported into other virtualization frameworks.
55

66
## Installation
77

8-
For now `git clone && cargo build --release`.
8+
See [docs/src/installation.md](./docs/src/installation.md).
99

1010
## Quick Start
1111

docs/src/installation.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,16 @@ Optional:
1818

1919
## Building from Source
2020

21+
Without cloning the repo:
22+
2123
```bash
22-
git clone https://github.com/cgwalters/bcvk.git
23-
cd bcvk
24-
cargo build --release
24+
cargo install --locked --git https://github.com/bootc-dev/bcvk bcvk
2525
```
2626

27-
Binary location: `target/release/bcvk`
27+
Inside a clone of the repo:
2828

29-
Install to PATH:
3029
```bash
31-
sudo cp target/release/bcvk /usr/local/bin/
30+
cargo install --locked --path crates/kit
3231
```
3332

3433
## Platform Support
@@ -37,4 +36,4 @@ sudo cp target/release/bcvk /usr/local/bin/
3736
- macOS: Not supported, use [podman-bootc](https://github.com/containers/podman-bootc/)
3837
- Windows: Not supported
3938

40-
See the [Quick Start Guide](./quick-start.md) to begin using bcvk.
39+
See the [Quick Start Guide](./quick-start.md) to begin using bcvk.

0 commit comments

Comments
 (0)