add usage instructions
All checks were successful
per-push tests / build (push) Successful in 46s
per-push tests / test-frontend (push) Successful in 39s
per-push tests / test-utility (push) Successful in 55s
per-push tests / test-backend (push) Successful in 52s
per-push tests / timed-decomposer-parse (push) Successful in 53s

This commit is contained in:
Kolby Heacock 2025-12-04 19:04:21 -07:00
parent cc60e45fab
commit 141ba43362
2 changed files with 41 additions and 1 deletions

View file

@ -2,7 +2,7 @@ cargo-features = ["profile-rustflags"]
[workspace] [workspace]
resolver = "2" resolver = "2"
members = ["mycelium", "decomposer", "hyphae", "organelle", "fairy-ring"] members = ["mycelium", "decomposer", "hyphae", "organelle"]
[profile.release] [profile.release]
opt-level = 3 opt-level = 3

View file

@ -8,6 +8,7 @@ project: a POSIX shell interpreter as well as a compiled to bytecode language fo
running on ESP32 devices. running on ESP32 devices.
## Current Status ## Current Status
The lexer and parser are implemented. On an X86 machine equipped with 64GB RAM 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 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 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. 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