Add some basic usage docs to README. #319
Conversation
README.md
Outdated
| Use the `subxt-cli` CLI tool to download the metadata for your target runtime from a Substrate node. | ||
|
|
||
| ```bash | ||
| cargo run -p subxt-cli -- metadata -f bytes > metadata.scale |
There was a problem hiding this comment.
Sure would be good to have a release on crates so we could write cargo install subxt-cli here. :/
There was a problem hiding this comment.
I suppose there's nothing stopping us releasing a subxt-cli 0.1
README.md
Outdated
| pub mod node_runtime { } | ||
| ``` | ||
|
|
||
| **Important:** `runtime_metadata_path` resolves to a path relative to the directory where your project's `Cargo.toml` |
There was a problem hiding this comment.
dq: relative the workspace Cargo.toml or the current crate's Cargo.toml?
There was a problem hiding this comment.
Ah whatever std::env::var("CARGO_MANIFEST_DIR") resolves to, which is would be the workspace I believe.
There was a problem hiding this comment.
I was curious so I had a play; it looks like, however you try compiling a crate in a workspace, CARGO_MANIFEST_DIR is always relative to the crate itself and not the workspace.
Which makes sense I think :)
There was a problem hiding this comment.
Ah yes the clue is in the name!
Co-authored-by: David <dvdplm@gmail.com>
Co-authored-by: David <dvdplm@gmail.com>
* Add some basic usage docs to README. * Update README.md Co-authored-by: David <dvdplm@gmail.com> * Update README.md Co-authored-by: David <dvdplm@gmail.com> * Update README to specify subxt-cli usage * Clarify CARGO_MANIFEST_DIR path Co-authored-by: David <dvdplm@gmail.com>
No description provided.