From 3d970a5a23528c9a20711339ed244de30e4c73e3 Mon Sep 17 00:00:00 2001
From: Kolby Heacock <codeshiftster@gmail.com>
Date: Thu, 4 Dec 2025 12:52:48 -0800
Subject: [PATCH] add usage instructions (#46)

Adds user commands to set up the Mycelium environment for usage and development

Reviewed-on: https://hephaestus.sunnypup.io/affine/Mycelium/pulls/46
Co-authored-by: Kolby Heacock <codeshiftster@gmail.com>
Co-committed-by: Kolby Heacock <codeshiftster@gmail.com>
---
 Cargo.toml |  2 +-
 readme.md  | 41 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 42 insertions(+), 1 deletion(-)

diff --git a/Cargo.toml b/Cargo.toml
index 32c5fb0..df6ee70 100755
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -2,7 +2,7 @@ cargo-features = ["profile-rustflags"]
 
 [workspace]
 resolver = "2"
-members = ["mycelium", "decomposer", "hyphae", "organelle", "fairy-ring"]
+members = ["mycelium", "decomposer", "hyphae", "organelle"]
 
 [profile.release]
 opt-level = 3
diff --git a/readme.md b/readme.md
index 576233d..6a2ef2c 100644
--- a/readme.md
+++ b/readme.md
@@ -8,6 +8,7 @@ project: a POSIX shell interpreter as well as a compiled to bytecode language fo
 running on ESP32 devices.
 
 ## Current Status
+
 The lexer and parser are implemented. On an X86 machine equipped with 64GB RAM
 and an AMD Ryzen 7900 CPU this lexer and parser are capable of creating a fully
 validated abstract syntax tree from approximately 11200 lines of handwritten scheme
@@ -33,3 +34,43 @@ The Linux/Mac/Windows runtime and extended compiler is not implemented.
 
 
 Documentation is not implemented.
+
+## Installation
+
+1. Install the Rust programming language. Here are the instructions for Unix-like dev environments for installing the nightly build for Rust
+
+```
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs/ | sh
+source $HOME/.cargo/env
+rustup toolchain install nightly
+rustup override set nightly
+```
+
+1. Verify nightly Rust dev env
+
+```
+cargo --version
+rustup toolchain list
+```
+
+1. Clone repositories for dev toolchain and language
+
+```
+git clone https://code.forgejo.org/msrd0/rust-toolchain.git
+git clone https://hephaestus.sunnypup.io/affine/Mycelium.git
+ ```
+
+## Testing
+
+1. Run all project's unit tests
+
+```
+cargo test --all-features
+```
+
+## License
+
+GNU General Public License 3
+
+Copyright (C) 2025 Ava Affine
+