particle-os/particle-os-cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: Update README to put preferred method of installation higher up

Browse source
This commit is contained in:
Gerald Pinder 2024-05-30 17:05:46 -04:00
parent b2aff68741
commit 5e7524918f
1 changed files with 28 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

56
README.md
View file

@ -18,6 +18,32 @@ The `bluebuild` tool takes advantage of newer build features. Specifically bind,
## Installation
### Cargo
This is the best way to install as it gives you the opportunity to build for your specific environment.
```bash
cargo install --locked blue-build
```
### Podman/Docker
This will install the binary on your system in `/usr/local/bin`. This is only a `linux-gnu` version.
```bash
podman run --pull always --rm ghcr.io/blue-build/cli:latest-installer | bash
```
```bash
docker run --pull always --rm ghcr.io/blue-build/cli:latest-installer | bash
```
### Github Install Script
```bash
bash <(curl -s https://raw.githubusercontent.com/blue-build/cli/main/install.sh)
```
### Distrobox
[distrobox-export-documentation]: https://distrobox.it/usage/distrobox-export/
@ -56,26 +82,6 @@ A CLI tool built for creating Containerfile templates based on the Ublue Communi
...
```
### Cargo
This is the best way to install as it gives you the opportunity to build for your specific environment.
```bash
cargo install --locked blue-build
```
### Podman/Docker
This will install the binary on your system in `/usr/local/bin`. This is only a `linux-gnu` version.
```bash
podman run --pull always --rm ghcr.io/blue-build/cli:latest-installer | bash
```
```bash
docker run --pull always --rm ghcr.io/blue-build/cli:latest-installer | bash
```
### Nix Flake
You can install this CLI through the Nix flake on [Flakehub](https://flakehub.com/)
@ -119,20 +125,14 @@ in {
You can also use `nix develop .#` in this repos directory to run a nix shell with development dependencies and some helful utilities for building BlueBuild!
### Github Install Script
```bash
bash <(curl -s https://raw.githubusercontent.com/blue-build/cli/main/install.sh)
```
## How to use
### Templating
### Generating `Containerfile`
Once you have the CLI tool installed, you can run the following to pull in your recipe file to generate a `Containerfile`.
```bash
bluebuild template -o <CONTAINERFILE> <RECIPE_FILE>
bluebuild generate -o <CONTAINERFILE> <RECIPE_FILE>
```
You can then use this with `podman` or `buildah` to build and publish your image. Further options can be viewed by running `bluebuild template --help`