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

Adds README for code generation #178

Merged
merged 6 commits into from
Nov 5, 2024
Merged

Adds README for code generation #178

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7f6cff0
Adds README for code generator
desaikd Nov 5, 2024
b8ecf4d
Add reference to code generation user guide
desaikd Nov 5, 2024
f14def1
Merge main branch to code-gen-README
desaikd Nov 5, 2024
e6deb5d
Adds suggested changes
desaikd Nov 5, 2024
bf00e49
Adds changes to CLI option for --authority option
desaikd Nov 5, 2024
1ef172b
Adds changes for rust code blocks
desaikd Nov 5, 2024
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
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ for working with [the Ion data format](https://amzn.github.io/ion-docs/docs/spec
* [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)
* [Ion code generation](#ion-code-generation)
* [Analyzing binary Ion file encodings with `inspect`](#analyzing-binary-ion-file-encodings-with-inspect)
* [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 @@ -84,6 +84,12 @@ Convert JSON to Ion:
ion from -X json my_file.json
```

### Ion Code generation

Code generation is supported with `generate` subcommand on the CLI.
For more information on how to use code generator,
see [Ion code generator user guide](https://github.com/amazon-ion/ion-cli/tree/main/src/bin/ion/commands/generate/README.md).

### Analyzing binary Ion file encodings with `inspect`

The `inspect` command can display the hex bytes of a binary Ion file alongside
Expand Down
Loading
Loading