From a3fa58c195d8afc242043bef53c4cbe7604312e5 Mon Sep 17 00:00:00 2001 From: Kolby Heacock Date: Thu, 4 Dec 2025 13:24:20 -0700 Subject: [PATCH 1/5] added license info --- readme.md | 43 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 42 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index 576233d..f8f049e 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 @@ -32,4 +33,44 @@ R7RS-Large is not implemented. The Linux/Mac/Windows runtime and extended compiler is not implemented. -Documentation is not implemented. +Documentation is still in progress. + +## 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 + From f9d5a755318beb367f21cc7bc9439baa6c771d12 Mon Sep 17 00:00:00 2001 From: Kolby Heacock Date: Thu, 4 Dec 2025 13:34:10 -0700 Subject: [PATCH 2/5] updated members in Cagro.toml --- Cargo.toml | 2 +- 1 file changed, 1 insertion(+), 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 From d973ccd0112a2129eccc4cf1c50e9141818f5119 Mon Sep 17 00:00:00 2001 From: Kolby Heacock Date: Thu, 4 Dec 2025 13:46:20 -0700 Subject: [PATCH 3/5] updated readme.md --- readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/readme.md b/readme.md index f8f049e..6a2ef2c 100644 --- a/readme.md +++ b/readme.md @@ -33,7 +33,7 @@ R7RS-Large is not implemented. The Linux/Mac/Windows runtime and extended compiler is not implemented. -Documentation is still in progress. +Documentation is not implemented. ## Installation From 3260424a9a89ce944bed1a9bddeb298b69b0217f Mon Sep 17 00:00:00 2001 From: Kolby Heacock Date: Thu, 4 Dec 2025 13:52:49 -0700 Subject: [PATCH 4/5] updated numbering --- readme.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/readme.md b/readme.md index 6a2ef2c..bd558e7 100644 --- a/readme.md +++ b/readme.md @@ -46,17 +46,16 @@ rustup toolchain install nightly rustup override set nightly ``` -1. Verify nightly Rust dev env +2. Verify nightly Rust dev env ``` cargo --version rustup toolchain list ``` -1. Clone repositories for dev toolchain and language +3. Clone repository ``` -git clone https://code.forgejo.org/msrd0/rust-toolchain.git git clone https://hephaestus.sunnypup.io/affine/Mycelium.git ``` From 141ba43362015ee727ffd71246b0895279fc011d Mon Sep 17 00:00:00 2001 From: Kolby Heacock Date: Thu, 4 Dec 2025 19:04:21 -0700 Subject: [PATCH 5/5] add usage instructions --- Cargo.toml | 2 +- readme.md | 40 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 41 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..4dc3cdf 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,42 @@ 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 +``` + +2. Verify nightly Rust dev env + +``` +cargo --version +rustup toolchain list +``` + +3. Clone repositories for dev toolchain and language + +``` +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 +