From 2b18187203df1facd587e9f7ff311f76042eac3b Mon Sep 17 00:00:00 2001 From: andreybleme Date: Wed, 18 Jun 2025 08:52:23 -0300 Subject: [PATCH] chore: add instructions to run locally --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index ea196fb..9fff895 100644 --- a/README.md +++ b/README.md @@ -26,3 +26,34 @@ cargo install container-compose We have made a `.tar.gz` containing the binary available on the release page. If you prefer to have your binary from there. + +### Running container-compose + +To run `container-compose` from the source code, first ensure you have [Rust](https://www.rust-lang.org/tools/install) installed. + +1. Clone the repository: + ```sh + git clone https://github.com/noghartt/container-compose.git + cd container-compose + ``` + +2. Build the project: + ```sh + cargo build --release + ``` + +3. Run `container-compose` using Cargo: + ```sh + cargo run -- [options] + ``` + For example, to start services: + ```sh + cargo run -- up + ``` + +You can also run the compiled binary directly: +```sh +./target/release/container-compose [options] +``` + +Replace `` and `[options]` with the desired subcommand and arguments.