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

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

Reviewed-on: #46
Co-authored-by: Kolby Heacock <codeshiftster@gmail.com>
Co-committed-by: Kolby Heacock <codeshiftster@gmail.com>
This commit is contained in:
Kolby Heacock 2025-12-04 12:52:48 -08:00 committed by Ava Apples Affine
parent cc60e45fab
commit 3d970a5a23
2 changed files with 42 additions and 1 deletions

View file

@ -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