Skip to content

Commit

Permalink
Adds README changes
Browse files Browse the repository at this point in the history
  • Loading branch information
desaikd committed Nov 1, 2024
1 parent 7509ba9 commit e60f854
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 15 deletions.
10 changes: 3 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# `ion-cli`

[![Crate](https://img.shields.io/crates/v/ion-cli.svg)](https://crates.io/crates/ion-cli)
[![License](https://img.shields.io/hexpm/l/plug.svg)](https://github.com/amazon-ion/ion-cli/blob/main/LICENSE)
[![CI Build](https://github.com/amazon-ion/ion-cli/workflows/CI%20Build/badge.svg)](https://github.com/amazon-ion/ion-cli/actions?query=workflow%3A%22CI+Build%22)
Expand All @@ -11,7 +12,8 @@ for working with [the Ion data format](https://amzn.github.io/ion-docs/docs/spec
* [Examples](#examples)
* [Viewing the contents of an Ion file](#viewing-the-contents-of-an-ion-file)
* [Converting between Ion formats](#converting-between-ion-formats)
* [Converting between Ion and other formats with `to` and `from`](#converting-between-ion-and-other-formats-with-to-and-from)
* [Converting between Ion and other formats with `to` and
`from`](#converting-between-ion-and-other-formats-with-to-and-from)
* [Analyzing binary Ion file encodings with `inspect`](#analyzing-binary-ion-file-encodings-with-inspect)
* [Installation](#installation)
* [via `brew`](#via-brew)
Expand Down Expand Up @@ -185,12 +187,6 @@ subcommand) of `ion-cli`, run:
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
13 changes: 5 additions & 8 deletions code-gen-projects/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,6 @@ 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`._

### Tests

The tests for the generated code are defined in `CodeGenTests.java`. It has the following tests:
Expand All @@ -101,12 +98,12 @@ The tests for the generated code are defined in `CodeGenTests.java`. It has the

Here are the steps to follow for running tests:

1. Install ion-cli with either `brew install ion-cli --HEAD` or `cargo install ion-cli --all-features`.
1. Install ion-cli with either `brew install ion-cli` or `cargo install ion-cli`.
1. If you installed with brew then your executable is there in `ion` and you don't need to set up `ION_CLI`
environment variable.
2. If you installed with `cargo` then your executable would be in `$HOME/.cargo/bin` and you need to setup the
environment variable `ION_CLI` to point to the executable's path. If you need latest commits from cargo which are
not released yet, then do `cargo install ion-cli --all-features --git https://github.com/amazon-ion/ion-cli.git`.
not released yet, then do `cargo install ion-cli --git https://github.com/amazon-ion/ion-cli.git`.
2. All the tests uses an environment variable `ION_INPUT` which has the path to input Ion files. So if you want to
test out this project locally set the environment variable `ION_INPUT` to point to `code-gen-projects/input.`_
3. `cd code-gen-projects/java/code-gen-demo`
Expand Down Expand Up @@ -178,7 +175,7 @@ fn main() {
```

_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`._
through `brew install ion-cli` or `cargo install ion-cli`._

### Tests

Expand All @@ -194,12 +191,12 @@ The tests for the generated code are defined in `tests` module in `lib.rs`. It h

Here are the steps to follow for running tests:

1. Install ion-cli with either `brew install ion-cli --HEAD` or `cargo install ion-cli --all-features`.
1. Install ion-cli with either `brew install ion-cli` or `cargo install ion-cli`.
1. If you installed with brew then your executable is there in `ion` and you need to setup the
environment variable `ION_CLI` to point to the executable's path.
2. If you installed with `cargo` then your executable would be in `$HOME/.cargo/bin` and you need to setup the
environment variable `ION_CLI` to point to the executable's path. If you need latest commits from cargo which are
not released yet, then do `cargo install ion-cli --all-features --git https://github.com/amazon-ion/ion-cli.git`.
not released yet, then do `cargo install ion-cli --git https://github.com/amazon-ion/ion-cli.git`.
2. `cd code-gen-projects/rust/code-gen-demo`
3. Finally, to run the tests, just do:

Expand Down

0 comments on commit e60f854

Please sign in to comment.