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. diff --git a/README.md b/README.md index 53262da28..1e40b861d 100644 --- a/README.md +++ b/README.md @@ -1,54 +1,55 @@ # 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. +## Documentation -## Install the CLI -Install [the latest soroban-cli version](https://github.com/stellar/soroban-cli/releases). -`cargo install --locked soroban-cli` +For installation options see below, for usage instructions [see the manual](/docs/soroban-cli-full-docs.md). -You can also install with `cargo-binstall`. +## Install +Install the latest version from source: ``` -cargo install cargo-binstall +cargo install --locked soroban-cli --features opt +``` + +Install with `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` - -## Full Docs -For autogenerated full docs, please see -[docs](/docs/soroban-cli-full-docs.md). +``` +echo "source <(soroban completion --shell bash)" >> ~/.bashrc +``` ## 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: - -``` -./install_githooks.sh -``` +## To Contribute +Find issues to contribute to [here](https://github.com/stellar/soroban-cli/contribute) and review [CONTRIBUTING.md](/CONTRIBUTING.md). -which copies the git hooks found at `.cargo-husky/hooks` to `.git/hooks`. +Developer Docs: https://developers.stellar.org/docs -## 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