diff --git a/README.md b/README.md index 4dc1fdf..aacf9fc 100644 --- a/README.md +++ b/README.md @@ -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 +bluebuild generate -o ``` 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`