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.

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

Tweaks to format and content of README #1245

Merged
merged 6 commits into from
Mar 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
45 changes: 27 additions & 18 deletions contributing.md → CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
```
leighmcculloch marked this conversation as resolved.
Show resolved Hide resolved

* 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
```
leighmcculloch marked this conversation as resolved.
Show resolved Hide resolved

* 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.


Expand Down
61 changes: 31 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).
leighmcculloch marked this conversation as resolved.
Show resolved Hide resolved

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
leighmcculloch marked this conversation as resolved.
Show resolved Hide resolved
leighmcculloch marked this conversation as resolved.
Show resolved Hide resolved
```

Install with `cargo-binstall`:
```
cargo install --locked cargo-binstall
cargo binstall -y soroban-cli
```

Install with Homebrew:

```
brew install stellar/tap/soroban-cli
```
leighmcculloch marked this conversation as resolved.
Show resolved Hide resolved

## Setup Autocomplete
`soroban completion --shell <SHELL>`
```
soroban completion --shell <SHELL>
```
leighmcculloch marked this conversation as resolved.
Show resolved Hide resolved
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
```
leighmcculloch marked this conversation as resolved.
Show resolved Hide resolved
## 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
Loading