Skip to content

Improve installation instructions #91

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cgwalters merged 1 commit into from
Oct 25, 2025
Merged

Improve installation instructions #91

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ disk images that can be imported into other virtualization frameworks.

## Installation

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

## Quick Start

Expand Down
13 changes: 6 additions & 7 deletions docs/src/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,16 @@ Optional:

## Building from Source

Without cloning the repo:

```bash
git clone https://github.com/cgwalters/bcvk.git
cd bcvk
cargo build --release
cargo install --locked --git https://github.com/bootc-dev/bcvk bcvk
```

Binary location: `target/release/bcvk`
Inside a clone of the repo:

Install to PATH:
```bash
sudo cp target/release/bcvk /usr/local/bin/
cargo install --locked --path crates/kit
```

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

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