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

Jump to bottom

Adds README changes for installation of experimental features #124

Merged
merged 1 commit into from
Jun 13, 2024
Merged

Adds README changes for installation of experimental features #124

Show file tree
Hide file tree
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
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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:

Expand Down
4 changes: 3 additions & 1 deletion code-gen-projects/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -131,4 +132,5 @@ fn main() {
println!("cargo:rerun-if-changed=input/");
println!("cargo:rerun-if-changed=schema/");
}
```
```
_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`._
Loading