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.

Sign up for GitHub

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

fix: zkstack readme update broken links and wording #3375

Merged
merged 2 commits into from
Dec 12, 2024
Merged

fix: zkstack readme update broken links and wording #3375

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1e13150
fix: update links & some wording
zk-Lumi Dec 10, 2024
007ef76
Merge branch 'main' into main
zk-Lumi Dec 12, 2024
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
16 changes: 8 additions & 8 deletions zkstack_cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# ZK Stack CLI

Toolkit for creating and managing ZK Stack chains. `ZK Stack CLI` facilitates the creation and management of ZK Stacks.
Commands are interactive but can also accept arguments via the command line.
Toolkit for creating and managing ZK Stack chains. `ZK Stack CLI` facilitates the creation and management of ZK Stack
ecosystems. Commands are interactive but can also accept arguments via the command line.

### Dependencies

Follow [these instructions](https://github.com/matter-labs/zksync-era/blob/main/docs/guides/setup-dev.md) to set up
Follow [these instructions](https://github.com/matter-labs/zksync-era/blob/main/docs/src/guides/setup-dev.md) to set up
dependencies on your machine. Ignore the Environment section for now.

### Installation
Expand Down Expand Up @@ -48,7 +48,7 @@ Foundry is used for deploying smart contracts. Pass flags for Foundry integratio
### Ecosystem

ZK Stack allows you to create a new ecosystem or connect to an existing one. An ecosystem includes components like the
BridgeHub, shared bridges, and state transition managers.
BridgeHub, shared bridges, and state transition managers. Multiple ZK chains can be registered to an ecosystem.
[Learn more](https://docs.zksync.io/zk-stack/components/shared-bridges).

#### Global Config
Expand Down Expand Up @@ -140,15 +140,15 @@ zkstack containers --observability

#### Create

The first ZK chain is generated upon ecosystem creation. Create additional chains and switch between them:
The first ZK chain is generated upon ecosystem creation. You can also create additional chains and switch between them:

```bash
zkstack chain create
```

#### Init

Deploy contracts and initialize Zk Chain:
Deploy contracts and initialize ZK chain:

```bash
zkstack chain init
Expand Down Expand Up @@ -184,7 +184,7 @@ Ensure you have installed:
- [cmake](https://apt.kitware.com/)
- [nvcc (CUDA toolkit)](https://developer.nvidia.com/cuda-downloads)

Refer to the [prover docs](https://github.com/matter-labs/zksync-era/blob/main/prover/docs/02_setup.md) for more
Refer to the [prover docs](https://github.com/matter-labs/zksync-era/blob/main/prover/docs/src/02_setup.md) for more
information.

#### Running the Prover
Expand Down Expand Up @@ -313,7 +313,7 @@ needed.

## Dev

The subcommand `zkstack dev` offers tools for developing ZKsync.
The subcommand `zkstack dev` offers tools for developing.

### Database

Expand Down
Loading