Skip to content

Commit 1c568c7

Browse files
committed
docs(README): Update install and development steps
1 parent 40a0978 commit 1c568c7

File tree

1 file changed

+36
-3
lines changed

1 file changed

+36
-3
lines changed

README.md

Lines changed: 36 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,53 @@ with the data's Content Identifier indexed within the appchain.
1212

1313
## Installation
1414

15-
Place this repo next to the `appchain` monorepo.
15+
This project uses local `file:` references to 0KN's
16+
[appchain](https://github.com/0KnowledgeNetwork/appchain) and
17+
[protokit](https://github.com/0KnowledgeNetwork/protokit).
18+
19+
Place the projects in the same directory and ensure alignment of their git refs:
1620

1721
```
1822
.
1923
├── appchain/
20-
└── appchain-agent/
24+
├── appchain-agent/
25+
└── protokit/
2126
```
2227

2328
Refer to appchain requirements including Node.js version.
2429

25-
Install dependencies:
30+
### Build Deps & Start Appchain
2631

2732
```sh
33+
cd protokit
34+
npm install
35+
npm run build
36+
37+
38+
cd ../appchain
39+
pnpm install
40+
41+
# build appchain for appchain-agent
42+
pnpm run build --filter=chain
43+
44+
# run appchain sequencer, for example
45+
pnpm env:inmemory dev --filter chain -- --logLevel DEBUG
46+
47+
48+
cd ../appchain-agent
2849
pnpm install
50+
pnpm run build
51+
```
52+
53+
## Development
54+
55+
Set `appchain` and `protokit` versions within [deps.env](deps.env) for the
56+
working branch so that automated workflows use the correct dependency verions.
57+
For example, for an `appchain-agent` `release/0.1` branch:
58+
59+
```env
60+
APPCHAIN=release/0.1
61+
PROTOKIT=zkn/release/0.1
2962
```
3063

3164
## Usage

0 commit comments

Comments
 (0)