From 4abd474f3161d3214a853e35b9d0793bef9440ba Mon Sep 17 00:00:00 2001
From: David Boreham <david@bozemanpass.com>
Date: Thu, 25 Apr 2024 06:30:09 -0600
Subject: [PATCH] Add readme doc

---
 README.md                       |  3 +++
 stacks/fixturenet-eth/README.md | 22 +++++++++++++++-------
 2 files changed, 18 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 86eb7a7..6117e17 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,5 @@
 # fixturenet-eth-stacks
 
+Experimental external packaging of the Ethereum fixturenet stack.
+
+[stack documentation](stacks/fixturenet-eth/README.md)
diff --git a/stacks/fixturenet-eth/README.md b/stacks/fixturenet-eth/README.md
index 6f1ec8e..398b8b3 100644
--- a/stacks/fixturenet-eth/README.md
+++ b/stacks/fixturenet-eth/README.md
@@ -1,17 +1,25 @@
 # fixturenet-eth
 
+TODO: update this doc to use a deployment.
+
 Instructions for deploying a local a geth + lighthouse blockchain "fixturenet" for development and testing purposes using laconic-stack-orchestrator (the installation of which is covered [here](https://git.vdb.to/cerc-io/stack-orchestrator)):
 
+## Clone the stack repo
+
+```
+$ laconic-so fetch-stack git.vdb.to/cerc-io/fixturenet-eth-stacks
+```
+
 ## Clone required repositories
 
 ```
-$ laconic-so --stack fixturenet-eth setup-repositories
+$ laconic-so --stack ~/cerc/fixturenet-eth-stacks/stacks/fixturenet-eth setup-repositories
 ```
 
 ## Build the fixturenet-eth containers
 
 ```
-$ laconic-so --stack fixturenet-eth build-containers
+$ laconic-so --stack ~/cerc/fixturenet-eth-stacks/stacks/fixturenet-eth build-containers
 ```
 
 This should create several container images in the local image registry:
@@ -24,20 +32,20 @@ This should create several container images in the local image registry:
 ## Deploy the stack
 
 ```
-$ laconic-so --stack fixturenet-eth deploy up
+$ laconic-so --stack ~/cerc/fixturenet-eth-stacks/stacks/fixturenet-eth deploy up
 ```
 
 ## Check status
 
 ```
-$ laconic-so --stack fixturenet-eth deploy exec fixturenet-eth-bootnode-lighthouse /scripts/status-internal.sh
+$ laconic-so --stack ~/cerc/fixturenet-eth-stacks/stacks/fixturenet-eth deploy exec fixturenet-eth-bootnode-lighthouse /scripts/status-internal.sh
 Waiting for geth to generate DAG.... done
 Waiting for beacon phase0.... done
 Waiting for beacon altair.... done
 Waiting for beacon bellatrix pre-merge.... done
 Waiting for beacon bellatrix merge.... done
 
-$ laconic-so --stack fixturenet-eth deploy ps
+$ laconic-so --stack ~/cerc/fixturenet-eth-stacks/stacks/fixturenet-eth deploy ps
 Running containers:
 id: c6538b60c0328dadfa2c5585c4d09674a6a13e6d712ff1cd82a26849e4e5679b, name: laconic-b12fa16e999821562937781f8ab0b1e8-fixturenet-eth-bootnode-geth-1, ports: 0.0.0.0:58909->30303/tcp, 0.0.0.0:58910->9898/tcp
 id: 5b70597a8211bc7e78d33e50486cb565a7f4a9ce581ce150b3bb450e342bdeda, name: laconic-b12fa16e999821562937781f8ab0b1e8-fixturenet-eth-bootnode-lighthouse-1, ports:
@@ -47,7 +55,7 @@ id: 387a42a14971034588ba9aeb9b9e2ca7fc0cc61b96f8fe8c2ab770c9d6fb1e0f, name: laco
 id: de5115bf89087bae03b291664a73ffe3554fe23e79e4b8345e088b040d5580ac, name: laconic-b12fa16e999821562937781f8ab0b1e8-fixturenet-eth-lighthouse-2-1, ports:
 id: 2a7e5a0fb2be7fc9261a7b725a40818facbbe6d0cb2497d82c0e02de0a8e959b, name: laconic-b12fa16e999821562937781f8ab0b1e8-foundry-1, ports:
 
-$ laconic-so --stack fixturenet-eth deploy exec foundry "cast block-number"
+$ laconic-so --stack ~/cerc/fixturenet-eth-stacks/stacks/fixturenet-eth deploy exec foundry "cast block-number"
 3
 ```
 
@@ -110,7 +118,7 @@ tx-spammer-1
 Stop all services running in the background:
 
 ```bash
-$ laconic-so --stack fixturenet-eth deploy down
+$ laconic-so --stack ~/cerc/fixturenet-eth-stacks/stacks/fixturenet-eth deploy down
 ```
 
 Clear volumes created by this stack:
-- 
2.45.2