Skip to content

Commit

Permalink
docs: Add manual installation instruction for zkstack_cli (#3160)
Browse files Browse the repository at this point in the history
## What ❔

Add manual installation instruction for zkstack_cli.
<!-- What are the changes this PR brings about? -->
<!-- Example: This PR adds a PR template to the repo. -->
<!-- (For bigger PRs adding more context is appreciated) -->

## Why ❔

Using `curl | bash` could be problematic, we should provide better way.
<!-- Why are these changes done? What goal do they contribute to? What
are the principles behind them? -->
<!-- Example: PR templates ensure PR reviewers, observers, and future
iterators are in context about the evolution of repos. -->

## Checklist

<!-- Check your PR fulfills the following items. -->
<!-- For draft PRs check the boxes as you complete them. -->

- [x] PR title corresponds to the body of PR (we generate changelog
entries from PRs).
- [ ] Tests for the changes have been added / updated.
- [ ] Documentation comments have been added / updated.
- [x] Code has been formatted via `zkstack dev fmt` and `zkstack dev
lint`.
  • Loading branch information
yorik authored Oct 23, 2024
1 parent bd1cdf6 commit 863a32e
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions zkstack_cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,16 @@ zkstackup --local

This command installs `zkstack` from the current repository.

#### Manual installation

Run from the repository root:

```bash
cargo install --path zkstack_cli/crates/zkstack --force --locked
```

And make sure that `.cargo/bin` is included into `PATH`.

### Foundry Integration

Foundry is used for deploying smart contracts. Pass flags for Foundry integration with the `-a` option, e.g.,
Expand Down

0 comments on commit 863a32e

Please sign in to comment.