diff --git a/.changes/2026111_1499_updatereadme.yml b/.changes/2026111_1499_updatereadme.yml new file mode 100644 index 0000000000..20c3319b8a --- /dev/null +++ b/.changes/2026111_1499_updatereadme.yml @@ -0,0 +1,22 @@ +project: cardano-cli + +# Pull request number associated with this change +pr: 1499 + +# One or more change kinds (see 'kinds' in .herald.yml) +kind: +# - breaking # the API has changed in a breaking way +# - feature # introduces a new feature +# - compatible # the API has changed but is non-breaking +# - bugfix # fixes a defect +# - optimisation # measurable performance improvements + - documentation # change in code docs, haddocks +# - refactoring # code quality improvements +# - test # fixes or modifies tests +# - maintenance # not directly related to the code +# - release # related to a new release preparation +description: | + To improve the first-time setup experience, this PR: + adds relevant installation links to the README + proposes a troubleshooting.md document to capture common issues and solutions + added discord channel \ No newline at end of file diff --git a/README.md b/README.md index 7d78b1a63a..b3d6091496 100644 --- a/README.md +++ b/README.md @@ -24,26 +24,33 @@ You can also download binaries of all versions of `cardano-cli` from [cardano-cl ## Documentation -* [Tutorials](https://developers.cardano.org/docs/get-started/infrastructure/cardano-cli/basic-operations/get-started) +* Tutorials on how to install and run a cardano-node and cardano-cli can be found in: + +- [Getting started with cardano-node](https://developers.cardano.org/docs/get-started/infrastructure/node/installing-cardano-node) +- [Getting started with cardano-cli](https://developers.cardano.org/docs/get-started/infrastructure/cardano-cli/basic-operations/get-started) Up to date command line help reference is available here: + * [List of all commands](cardano-cli/test/cardano-cli-golden/files/golden/help.cli) * [Description of each command's options](cardano-cli/test/cardano-cli-golden/files/golden/help) -To read a file from standard input, use `-` as the file path. For example: +Development documentation can be found in: -```sh -cat certificate.json | cardano-cli debug certificate view --certificate-file - -``` +- [Cardano Node Wiki](https://github.com/input-output-hk/cardano-node-wiki/wiki) -Development documentation can be found in [Cardano Node Wiki](https://github.com/input-output-hk/cardano-node-wiki/wiki). +Haddock documentation is available at: -Haddock documentation is available at: https://cardano-cli.cardano.intersectmbo.org/ +- https://cardano-cli.cardano.intersectmbo.org/ ## Contributing See the [Contributing guide](CONTRIBUTING.md) for how to contribute to this project. +## Community and Support + +- [Discord API/CLI Community](https://discordapp.com/channels/1136727663583698984/1239888777015590913) +- [Troubleshooting](troubleshooting.md) + ## Core maintainers * [Jordan Millar](https://github.com/Jimbo4350) [ BlockPQR ](https://blockpqr.io) @@ -55,5 +62,4 @@ See the [Contributing guide](CONTRIBUTING.md) for how to contribute to this proj [![aarch64-darwin](https://img.shields.io/endpoint?url=https://ci.iog.io/job/IntersectMBO-cardano-cli/master/aarch64-darwin.required/shield&style=flat-square&label=aarch64-darwin)](https://ci.iog.io/job/IntersectMBO-cardano-cli/master/aarch64-darwin.required) [![GHA Build](https://img.shields.io/github/actions/workflow/status/intersectmbo/cardano-cli/haskell.yml?branch=master&label=GHA%20Build&style=flat-square)](https://github.com/IntersectMBO/cardano-cli/actions/workflows/haskell.yml?query=branch%3Amaster) [![Haddock](https://img.shields.io/github/actions/workflow/status/intersectmbo/cardano-cli/github-page.yml?branch=master&label=Haddocks&style=flat-square)](https://github.com/IntersectMBO/cardano-cli/actions/workflows/github-page.yml?query=branch%3Amaster) -[![Release Upload](https://img.shields.io/github/actions/workflow/status/intersectmbo/cardano-cli/release-upload.yml?label=GH%20Release%20Upload&style=flat-square)](https://github.com/IntersectMBO/cardano-cli/actions/workflows/release-upload.yml) - +[![Release Upload](https://img.shields.io/github/actions/workflow/status/intersectmbo/cardano-cli/release-upload.yml?label=GH%20Release%20Upload&style=flat-square)](https://github.com/IntersectMBO/cardano-cli/actions/workflows/release-upload.yml) \ No newline at end of file