From 38538732a913c8f893ca91c520656873f67f935e Mon Sep 17 00:00:00 2001
From: pcarlson-foundry-digital <pcarlson@foundrydigital.com>
Date: Mon, 6 Jan 2025 13:08:51 -0500
Subject: [PATCH] readme updates

---
 .env.validator.example | 15 +++++++++++++++
 Makefile               |  3 ++-
 README.md              | 25 ++++++++++++++++++++-----
 3 files changed, 37 insertions(+), 6 deletions(-)

diff --git a/.env.validator.example b/.env.validator.example
index e69de29..1f444d0 100644
--- a/.env.validator.example
+++ b/.env.validator.example
@@ -0,0 +1,15 @@
+# Network Configuration
+NETWORK=localnet  # Options: localnet, testnet, finney
+
+# Wallet Configuration
+COLDKEY=validator
+VALIDATOR_HOTKEY=default
+
+# Node Configuration
+VALIDATOR_NAME=validator
+VALIDATOR_PORT=8091
+AXON_IP=127.0.0.1
+AXON_EXTERNAL_IP=127.0.0.1
+
+# Logging
+LOGGING_LEVEL=info  # Options: info, debug, trace
diff --git a/Makefile b/Makefile
index 70b6b4c..58babb6 100644
--- a/Makefile
+++ b/Makefile
@@ -12,7 +12,8 @@ ifeq ($(NETWORK),localnet)
 else ifeq ($(NETWORK),testnet)
    netuid = 256
 else ifeq ($(NETWORK),finney)
-   netuid = 64
+   #netuid = 64
+   $(error Finney network not supported yet)
 endif
 
 metagraph:
diff --git a/README.md b/README.md
index 044997b..5769686 100644
--- a/README.md
+++ b/README.md
@@ -57,7 +57,7 @@ cd precog
 
 Create and source a python virtual environment:
 ```
-python3 -m venv
+python3 -m venv .venv
 source .venv/bin/activate
 ```
 
@@ -71,7 +71,7 @@ poetry install
 ## Configuration
 
 ### Makefile
-Start by editing the Makefile with you wallet and network information:
+Start by editing the Makefile with your wallet and network information:
 ```
 ################################################################################
 #                               User Parameters                                #
@@ -83,6 +83,21 @@ netuid = $(testnet_netuid)
 network = $(testnet)
 ```
 
+### .env Files
+Copy the example `.env` files and edit all desired values:
+
+#### .env.validator
+```
+cp .env.validator.example .env.validator
+```
+Edit `.env.validator` with your desired values.
+
+#### .env.miner
+```
+cp .env.miner.example .env.miner
+```
+Edit `.env.miner` with your desired values.
+
 ### Wandb
 Wandb integration is planned for mainnet launch and does not currently work.
 
@@ -93,7 +108,7 @@ Wandb integration is planned for mainnet launch and does not currently work.
 Base miner:
 1. Run the command:
     ```
-    make miner
+    make miner ENV_FILE=.env.miner
     ```
 
 Custom miner:
@@ -107,13 +122,13 @@ Custom miner:
     - replace the `--forward_function base_miner` with `--forward_function your_file`
 3. Run the Command:
     ```
-    make miner_custom
+    make miner_custom ENV_FILE=.env.custom
     ```
 
 
 ### Running a Validator
 ```
-make validator
+make validator ENV_FILE=.env.validator
 ```