Skip to content

Commit

Permalink
fix(zk_toolbox): improve readme to include containers command and cd (m…
Browse files Browse the repository at this point in the history
…atter-labs#2073)

## What ❔

- readme added dependencies section and cleaned up
- fixed name of chain

## Why ❔

- to help testers

## 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 `zk fmt` and `zk lint`.
- [x] Spellcheck has been run via `zk spellcheck`.
  • Loading branch information
zk-Lumi authored May 29, 2024
1 parent 9d5631c commit 5e5628f
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
9 changes: 8 additions & 1 deletion zk_toolbox/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,14 @@ To create a ZK Stack project, you must first create an ecosystem:
zk_inception ecosystem create
```

All subsequent commands should be executed from within the ecosystem folder.
If you chose to not start database & L1 containers after creating the ecosystem, you can later run
`zk_inception containers`

All subsequent commands should be executed from within the ecosystem folder you created:

```bash
cd `path/to/ecosystem/name`
```

If the ecosystem has never been deployed before, initialization is required:

Expand Down
2 changes: 1 addition & 1 deletion zk_toolbox/crates/zk_inception/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ pub enum InceptionSubcommands {
/// Ecosystem related commands
#[command(subcommand)]
Ecosystem(EcosystemCommands),
/// Hyperchain related commands
/// Chain related commands
#[command(subcommand)]
Chain(ChainCommands),
/// Run server
Expand Down

0 comments on commit 5e5628f

Please sign in to comment.