fix: update README to point to new project
This commit is contained in:
parent
ff3f066cbf
commit
8047702582
3 changed files with 4 additions and 44 deletions
2
Cargo.lock
generated
2
Cargo.lock
generated
|
|
@ -1077,7 +1077,7 @@ checksum = "42ff0bf0c66b8238c6f3b578df37d0b7848e55df8577b3f74f92a69acceeb825"
|
|||
|
||||
[[package]]
|
||||
name = "ublue-rs"
|
||||
version = "0.3.6"
|
||||
version = "0.3.7"
|
||||
dependencies = [
|
||||
"anyhow",
|
||||
"cfg-if",
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
[package]
|
||||
name = "ublue-rs"
|
||||
version = "0.3.6"
|
||||
version = "0.3.7"
|
||||
edition = "2021"
|
||||
description = "A CLI tool built for creating Containerfile templates based on the Ublue Community Project"
|
||||
repository = "https://gitlab.com/wunker-bunker/ublue-cli"
|
||||
repository = "https://gitlab.com/wunker-bunker/blue-build"
|
||||
license = "Apache-2.0"
|
||||
categories = ["command-line-utilities"]
|
||||
|
||||
|
|
|
|||
42
README.md
42
README.md
|
|
@ -1,41 +1 @@
|
|||
# Ublue CLI
|
||||
|
||||
This is my personal project trying to create a more conise version of the [starting point](https://github.com/ublue-os/startingpoint/tree/template) repo all condensed into a single Rust based CLI tool.
|
||||
|
||||
## Installation
|
||||
|
||||
Right now the only way to install this tool is to use `cargo`.
|
||||
|
||||
```bash
|
||||
cargo install --locked ublue-rs
|
||||
```
|
||||
|
||||
## How to use
|
||||
|
||||
### Templating
|
||||
|
||||
Once you have the CLI tool installed, you can run the following to pull in your recipe file to generate a `Containerfile`.
|
||||
|
||||
```bash
|
||||
ublue template -o <CONTAINERFILE> <RECIPE_FILE>
|
||||
```
|
||||
|
||||
You can then use this with `podman` to build and publish your image. Further options can be viewed by running `ublue template --help`
|
||||
|
||||
### Building
|
||||
|
||||
If you don't care about the details of the template, you can run the `build` command.
|
||||
|
||||
```bash
|
||||
ublue build ./config/recipe.yaml
|
||||
```
|
||||
|
||||
This will template out the file and build with `buildah` or `podman`. If you're running in Gitlab CI with the pipeline like in the [init template](templates/init/gitlab-ci.yml.tera), it will automatically sign your image using Gitlab's own OIDC service.
|
||||
|
||||
## Future Features
|
||||
|
||||
- [x] Update to the most recent stable style of the [starting point](https://github.com/ublue-os/startingpoint/tree/template) template
|
||||
- [x] Setup pipeline automation for publishing
|
||||
- [ ] Create an init command to create a repo for you to start out
|
||||
- [ ] Setup the project to allow installing with `binstall`
|
||||
- [ ] Create an install script for easy install for users without `cargo`
|
||||
This project has been renamed and moved! You can find us at https://crates.io/crates/blue-build
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue