Skip to content

Commit 78f43ac

Browse files
add comment ux the structure
1 parent 740b3e9 commit 78f43ac

File tree

1 file changed

+20
-14
lines changed

1 file changed

+20
-14
lines changed

docs/cdk/getting-started/local-deployment.md

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,51 @@
1-
## Deploy CDK locally
1+
---
2+
comments: true
3+
---
24

3-
This guide walks you through the process of setting up and deploying a layer 2 blockchain on your local machine using the Polygon CDK with [Kurtosis](https://docs.kurtosis.com/).
5+
This guide walks you through the process of setting up and deploying a layer 2 CDK blockchain on your local machine.
46

5-
The components run in Docker containers.
7+
The [Polygon CDK Kurtosis package](https://github.com/0xPolygon/kurtosis-cdk/) allows you to easily customize and instantiate all the components of a CDK chain. It uses the [Kurtosis](https://docs.kurtosis.com/) tool to orchestrate the setup of the chain components in Docker containers, with logic defined in [Starlark](https://github.com/bazelbuild/starlark) scripts (a Python dialect) which define the step-by-step process of setting up the chain.
8+
9+
!!! tip
10+
Check out the [Polygon Kurtosis docs](https://github.com/0xPolygon/kurtosis-cdk) for more documentation on this stack and how to use it, and if you need to raise an issue or have a question for the team.
611

712
## Prerequisites
813

914
### Hardware
1015

11-
- A Linux-based operating system (or [WSL](https://learn.microsoft.com/en-us/windows/wsl/about)).
12-
- Minimum 8GB RAM and 2-core CPU.
13-
- An AMD64 architecture system.
16+
- Linux-based OS (or [WSL](https://learn.microsoft.com/en-us/windows/wsl/about)).
17+
- Minimum 8GB RAM/2-core CPU.
18+
- AMD64 architecture.
1419

1520
### Software
1621

1722
- [Docker Engine](https://docs.docker.com/engine/) version 4.27 or higher.
1823
- [Kurtosis CLI](https://docs.kurtosis.com/install/)
1924
- [Foundry](https://book.getfoundry.sh/getting-started/installation)
25+
26+
And for submitting transactions and interacting with the environment once set up:
27+
2028
- [yq](https://github.com/mikefarah/yq)
2129
- [jq](https://stedolan.github.io/jq/)
22-
- [polycli](https://github.com/maticnetwork/polygon-cli) to help submit transactions and interact with the environment.
30+
- [polyon-cli](https://github.com/maticnetwork/polygon-cli)
2331

2432
## Set up the Kurtosis environment
2533

26-
The [Polygon CDK Kurtosis package](https://github.com/0xPolygon/kurtosis-cdk/) allows you to easily customize and instantiate all the components of a CDK chain. It uses the [Kurtosis](https://docs.kurtosis.com/) tool to orchestrate the setup of the chain components in Docker containers, with logic defined in [Starlark](https://github.com/bazelbuild/starlark) scripts (a Python dialect) that define the step-by-step process of setting up the chain.
27-
2834
### Clone the repository
2935

30-
To get started, clone the repository and navigate to the `kurtosis-cdk` directory:
31-
3236
```bash
3337
git clone https://github.com/0xPolygon/kurtosis-cdk.git
3438
cd kurtosis-cdk
3539
```
3640

3741
### Check your environment
3842

39-
Ensure Docker is running on your machine, then run the following command to confirm that all prerequisites are installed:
43+
Run the `tool_check.sh` script to confirm you have all the prerequisite software.
4044

41-
```bash
42-
sh scripts/tool_check.sh
45+
You may need to make the script executable: `chmod +x scripts/tool_check.sh`
46+
47+
```sh
48+
./scripts/tool_check.sh
4349
```
4450

4551
If everything is installed correctly, you should see the following output:

0 commit comments

Comments
 (0)