Skip to content

Commit

Permalink
fix: zkstack readme update broken links and wording (#3375)
Browse files Browse the repository at this point in the history
## What ❔

Hi @Deniallugo @popzxc πŸ‘‹

Was playing with zkstack cli today. 

This PR is just fixing a couple of broken links and updating a bit of
wording in `zkstack_cli/README.md`.

PS: sidenote, "EVM emulator" is not explained in this readme, and
"Enable EVM emulator?" in interactive mode will be confusing to people
(they likely wont realize that it is emulating EVM equivalence but not
required for most chains + will be more expensive)

## Why ❔

Possibly a bit OCD, ie "Zk" being wrongly cased in one instance stayed
in my mind and bothered me hahahah πŸ˜‰
<!-- 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).
- [x] Tests for the changes have been added / updated.
- [x] Documentation comments have been added / updated.
- [x] Code has been formatted via `zkstack dev fmt` and `zkstack dev
lint`.
  • Loading branch information
zk-Lumi authored Dec 12, 2024
1 parent 9821445 commit ee117a8
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions zkstack_cli/README.md
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

0 comments on commit ee117a8

Please sign in to comment.