Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CLI usage help output to libcnb-cargo README #674

Merged
merged 1 commit into from
Sep 14, 2023
+18 −2
Merged

Add CLI usage help output to libcnb-cargo README #674

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions libcnb-cargo/README.md
View file
Open in desktop
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