Skip to content

Commit

Permalink
Improve docs (#40)
Browse files Browse the repository at this point in the history
* use latest coretim-utils

* improve docs
  • Loading branch information
Szegoo authored Jan 18, 2024
1 parent 1ca97d8 commit 757b1ed
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 5 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ The local environment consists of three chains:

### Getting started with Zombienet

NOTE: Before proceeding make sure to have zombienet setup on your machine and accessible from your PATH.
You can find linux and macOS executables of the Zombienet CLI [here](https://github.com/paritytech/zombienet/releases)

```sh
# Clone the repo:
git clone https://github.com/RegionX-Labs/Coretime-Mock.git
Expand Down Expand Up @@ -78,8 +81,13 @@ This repo provides an init program which will based on the selected options set
- Description: Specify an account on the coretime chain. When specified the program will transfer a mock region to this account.

**An example with all options:**

> NOTE: As explained above `npm run zombienet:full` must be running in the background to be able to proceed with the following steps:
```sh
# Before executing the zombienet-init:full command, ensure that the contracts within the RegionX directory are compiled.
# Before compiling the contract make sure the pallet index is configured correctly for Shibuya:
# https://github.com/RegionX-Labs/RegionX?tab=readme-ov-file#4-deploy
# To compile the contracts, navigate to the RegionX directory and execute the following commands:
#
# cd RegionX/contracts/xc-regions
Expand Down
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"@polkadot/util-crypto": "^12.6.2",
"bn.js": "^5.2.1",
"commander": "^11.1.0",
"coretime-utils": "^0.1.9",
"coretime-utils": "^0.2.3",
"ts-node": "^10.9.2"
},
"devDependencies": {
Expand Down

0 comments on commit 757b1ed

Please sign in to comment.