Skip to content

Commit

Permalink
Add CLI usage help output to libcnb-cargo README
Browse files Browse the repository at this point in the history
To improve visibility of the various customisation options.
  • Loading branch information
edmorley committed Sep 14, 2023
1 parent b149bfb commit c4c86c3
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions libcnb-cargo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,24 @@ $ cargo install libcnb-cargo

## Usage

Currently, there is only one sub-command: `package`. It allows users to package their Rust buildpack in a spec-compliant
manner and helps with cross-compilation. Using it is fairly simple, run `cargo libcnb package` inside the buildpack's
Currently, there is only one sub-command: `package`. It allows users to package their
Rust buildpack in a spec-compliant manner and helps with cross-compilation.

```shell
$ cargo libcnb package --help
Packages a libcnb.rs Cargo project as a Cloud Native Buildpack

Usage: cargo libcnb package [OPTIONS]

Options:
--no-cross-compile-assistance Disable cross-compile assistance
--release Build in release mode, with optimizations
--target <TARGET> Build for the target triple [default: x86_64-unknown-linux-musl]
--package-dir <PACKAGE_DIR> Directory for packaged buildpacks, defaults to 'packaged' in Cargo workspace root
-h, --help Print help
```
Using it is fairly simple, run `cargo libcnb package` inside the buildpack's
project directory:
```shell
Expand Down

0 comments on commit c4c86c3

Please sign in to comment.