From b2f8ba735115879ce380b8dd609c9b14a5d2194f Mon Sep 17 00:00:00 2001 From: Khushboo Desai Date: Thu, 13 Jun 2024 13:15:22 -0700 Subject: [PATCH] Adds README changes for installation of experimental features --- README.md | 17 +++++++++++++++++ code-gen-projects/README.md | 4 +++- 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9cf46a0..9aa6e5e 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@ for working with [the Ion data format](https://amzn.github.io/ion-docs/docs/spec * [Installation](#installation) * [via `brew`](#via-brew) * [via `cargo`](#via-cargo) + * [Installing experimental subcommand for code generation](#installing-experimental-subcommand-for-code-generation) * [Build Instructions](#build-instructions) * [From source](#from-source) * [Using Docker](#using-docker) @@ -171,6 +172,22 @@ To install `ion-cli`, run the following command: cargo install ion-cli ``` +### Installing experimental subcommand for code generation + +If you are looking into accessing all features with `brew` (including `experimental` features, currently only +includes `generate` +subcommand under `beta`) of `ion-cli`, run: + +```bash +brew install ion-cli --HEAD +``` + +If you are looking into accessing all features with `cargo` (including `experimental` features) of `ion-cli`, run: + +```shell +cargo install ion-cli --all-features +``` + Then make sure that `~/.cargo/bin` is on your `$PATH`. You can confirm that it has been installed successfully by running: diff --git a/code-gen-projects/README.md b/code-gen-projects/README.md index a8827ed..8a77508 100644 --- a/code-gen-projects/README.md +++ b/code-gen-projects/README.md @@ -78,6 +78,7 @@ tasks { } } ``` +_Note: Code generation subcommand `generate` is under a feature flag. It is available through `brew install ion-cli --HEAD` or `cargo install ion-cli --all-features`._ ## /rust @@ -131,4 +132,5 @@ fn main() { println!("cargo:rerun-if-changed=input/"); println!("cargo:rerun-if-changed=schema/"); } -``` \ No newline at end of file +``` +_Note: Code generation subcommand `generate` is under a feature flag. It is available through `brew install ion-cli --HEAD` or `cargo install ion-cli --all-features`._