From 5e2493710e06ceb23acc8827f20a4867e6128405 Mon Sep 17 00:00:00 2001 From: Clement Verna Date: Thu, 1 Oct 2020 11:52:38 +0200 Subject: [PATCH] Add a Readme Signed-off-by: Clement Verna --- README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..8c9266e --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ +fedora-container-release +======================== + +This project is a Command Line Interface (CLI) tool which fetch the Fedora container base image +rootfs from [Fedora's build system](https://koji.fedoraproject.org) and prepares it to be pushed to +[docker-brew-fedora](https://github.com/fedora-cloud/docker-brew-fedora) repository which is used to +update our images in the Docker Hub. + +This cli is currently used in a [GitHub action](https://github.com/fedora-cloud/docker-brew-fedora/blob/master/.github/workflows/main.yml) define in the docker-brew-fedora repo + + +## Development + +To start hacking on that repository you need the Rust package manager Cargo installed on your local machine. + +## Clone the repository + +``` +$ git clone https://github.com/fedora-cloud/fedora-container-release.git +$ cd fedora-container-release +``` + +## Run the application + +``` +$ cargo run -- --release 33 +``` + +## Build a release binary + +``` +$ cargo build --release +$ ll target/release/fedora-container-release +$ target/release/fedora-container-release --help +fedora-container-release 0.1.0 + +USAGE: + fedora-container-release --release + +FLAGS: + -h, --help Prints help information + -V, --version Prints version information + +OPTIONS: + -r, --release +``` +