From 7062beb7c6b74f38972e50e673b08f098ed32c8c Mon Sep 17 00:00:00 2001 From: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com> Date: Tue, 5 Mar 2024 17:36:20 -0800 Subject: [PATCH 1/6] Tweaks to format and content of README --- README.md | 57 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 30 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 53262da28..ac47ac385 100644 --- a/README.md +++ b/README.md @@ -1,54 +1,57 @@ # Soroban CLI (soroban-cli) -This repo is home to the [Soroban CLI](https://github.com/stellar/soroban-tools/tree/main/cmd/soroban-cli): The command-line multi-tool for running and deploying Soroban contracts. +This repo is home to the Soroban CLI, the command-line multi-tool for running and deploying Soroban contracts on the Stellar network. -## Install the CLI -Install [the latest soroban-cli version](https://github.com/stellar/soroban-cli/releases). -`cargo install --locked soroban-cli` +## Install +Install the latest version from source: +``` +cargo install --locked soroban-cli --features opt +``` -You can also install with `cargo-binstall`. +Install with `cargo-binstall`: ``` -cargo install cargo-binstall +cargo install --locked cargo-binstall cargo binstall -y soroban-cli ``` +Install with [Homebrew]: + +``` +brew install stellar/tap/soroban-cli +``` + ## Setup Autocomplete -`soroban completion --shell ` +``` +soroban completion --shell +``` Possible SHELL values are `bash`, `elvish`, `fish`, `powershell`, `zsh`, etc. To enable autocomplete in the current bash shell, run: -`source <(soroban completion --shell bash)` +``` +source <(soroban completion --shell bash) +``` To enable autocomplete permanently, run: -`echo "source <(soroban completion --shell bash)" >> ~/.bashrc` +``` +echo "source <(soroban completion --shell bash)" >> ~/.bashrc +``` ## Full Docs -For autogenerated full docs, please see -[docs](/docs/soroban-cli-full-docs.md). +For full docs, see [docs](/docs/soroban-cli-full-docs.md). ## Latest Release -For latest releases, please see -[releases](https://github.com/stellar/soroban-cli/releases). +For latest releases, see [releases](https://github.com/stellar/soroban-cli/releases). ## Upcoming Features -For upcoming features, please see the [project -board](https://github.com/orgs/stellar/projects/50). - +For upcoming features, please see the [project board](https://github.com/orgs/stellar/projects/50). -## Adding Git Hooks - -To add git hooks for commits and pushes run: +## To Contribute +Please fork this see `good first issues` on [here](https://github.com/stellar/soroban-cli/contribute) and review [contributing.md](/contributing.md). -``` -./install_githooks.sh -``` +Developer Docs: https://developers.stellar.org/docs -which copies the git hooks found at `.cargo-husky/hooks` to `.git/hooks`. +[Homebrew]: https://brew.sh -## To Contribute -Please fork this see `good first issues` on -[here](https://github.com/stellar/soroban-cli/contribute) and review the [contributing.md](/contributing.md). -Developer Docs: https://developers.stellar.org/docs From 18cf6cd376e6900ca12772a122c505620f539126 Mon Sep 17 00:00:00 2001 From: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com> Date: Tue, 5 Mar 2024 17:42:03 -0800 Subject: [PATCH 2/6] move instructions about contributing to the contributing doc --- contributing.md => CONTRIBUTING.md | 45 ++++++++++++++++++------------ 1 file changed, 27 insertions(+), 18 deletions(-) rename contributing.md => CONTRIBUTING.md (80%) diff --git a/contributing.md b/CONTRIBUTING.md similarity index 80% rename from contributing.md rename to CONTRIBUTING.md index 84fab097b..7392dc67b 100644 --- a/contributing.md +++ b/CONTRIBUTING.md @@ -39,29 +39,38 @@ Of course, feel free to create a new issue if you think something needs to be ad ## Making Changes * Fork the soroban-cli repo to your own Github account + * List the current configured remote repository for your fork. Your git remote - should initially look like this. -``` -$ git remote -v -> origin https://github.com/YOUR_USERNAME/soroban-cli.git (fetch) -> origin https://github.com/YOUR_USERNAME/soroban-cli.git (push)` -``` +should initially look like this. + ``` + $ git remote -v + > origin https://github.com/YOUR_USERNAME/soroban-cli.git (fetch) + > origin https://github.com/YOUR_USERNAME/soroban-cli.git (push) + ``` + * Set the `stellar/soroban-cli` repo as new remote upstream repository that will - sync with your fork. -``` -git remote add upstream https://github.com/stellar/soroban-cli.git -``` +sync with your fork. + ``` + git remote add upstream https://github.com/stellar/soroban-cli.git + ``` * Verify the new upstream repository you've specified for your fork. -``` -$ git remote -v -> origin https://github.com/YOUR_USERNAME/soroban-cli.git (fetch) -> origin https://github.com/YOUR_USERNAME/soroban-cli.git (push) -> upstream https://github.com/stellar/soroban-cli.git (fetch) -> upstream https://github.com/stellar/soroban-cli.git (push) -``` + ``` + $ git remote -v + > origin https://github.com/YOUR_USERNAME/soroban-cli.git (fetch) + > origin https://github.com/YOUR_USERNAME/soroban-cli.git (push) + > upstream https://github.com/stellar/soroban-cli.git (fetch) + > upstream https://github.com/stellar/soroban-cli.git (push) + ``` + +* Add git hooks for commits and pushes so that checks run before pushing: + ``` + ./install_githooks.sh + ``` + * Create a topic branch for your changes in your local repo. When you push you should be able - to create PR based on upstream stellar/soroban-cli. +to create PR based on upstream stellar/soroban-cli. + * Make sure you have added the necessary tests for your changes and make sure all tests pass. From 5dea902cac3283a43b0b9dc7fadb89704e672bb2 Mon Sep 17 00:00:00 2001 From: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com> Date: Tue, 5 Mar 2024 17:43:02 -0800 Subject: [PATCH 3/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ac47ac385..c4ceaeaa2 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ For latest releases, see [releases](https://github.com/stellar/soroban-cli/relea For upcoming features, please see the [project board](https://github.com/orgs/stellar/projects/50). ## To Contribute -Please fork this see `good first issues` on [here](https://github.com/stellar/soroban-cli/contribute) and review [contributing.md](/contributing.md). +Find issues to contribute to [here](https://github.com/stellar/soroban-cli/contribute) and review [CONTRIBUTING.md](/CONTRIBUTING.md). Developer Docs: https://developers.stellar.org/docs From 42a46a04729beab807a737109594005d494b547a Mon Sep 17 00:00:00 2001 From: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com> Date: Tue, 5 Mar 2024 17:43:36 -0800 Subject: [PATCH 4/6] Update README.md --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index c4ceaeaa2..fd5ab7963 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ cargo install --locked cargo-binstall cargo binstall -y soroban-cli ``` -Install with [Homebrew]: +Install with Homebrew: ``` brew install stellar/tap/soroban-cli @@ -51,7 +51,5 @@ Find issues to contribute to [here](https://github.com/stellar/soroban-cli/contr Developer Docs: https://developers.stellar.org/docs -[Homebrew]: https://brew.sh - From c4f22a7c0dcb69650658fa28f473e9759d2072f5 Mon Sep 17 00:00:00 2001 From: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com> Date: Tue, 5 Mar 2024 17:44:33 -0800 Subject: [PATCH 5/6] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fd5ab7963..b43250675 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,9 @@ Install with Homebrew: brew install stellar/tap/soroban-cli ``` +## Manual +For the full command-line manual, see [docs](/docs/soroban-cli-full-docs.md). + ## Setup Autocomplete ``` soroban completion --shell @@ -37,9 +40,6 @@ To enable autocomplete permanently, run: echo "source <(soroban completion --shell bash)" >> ~/.bashrc ``` -## Full Docs -For full docs, see [docs](/docs/soroban-cli-full-docs.md). - ## Latest Release For latest releases, see [releases](https://github.com/stellar/soroban-cli/releases). From da0e2ba7cb704ff66cf3b70728861396921cf8c6 Mon Sep 17 00:00:00 2001 From: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com> Date: Tue, 5 Mar 2024 17:47:26 -0800 Subject: [PATCH 6/6] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b43250675..1e40b861d 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,9 @@ This repo is home to the Soroban CLI, the command-line multi-tool for running and deploying Soroban contracts on the Stellar network. +## Documentation + +For installation options see below, for usage instructions [see the manual](/docs/soroban-cli-full-docs.md). ## Install Install the latest version from source: @@ -21,9 +24,6 @@ Install with Homebrew: brew install stellar/tap/soroban-cli ``` -## Manual -For the full command-line manual, see [docs](/docs/soroban-cli-full-docs.md). - ## Setup Autocomplete ``` soroban completion --shell