From d0565722a99c105dda0be90905996a4d030f4038 Mon Sep 17 00:00:00 2001 From: KIYINI Joseph Balamazze <73903994+josephkb87@users.noreply.github.com> Date: Thu, 24 Sep 2026 00:39:51 +0300 Subject: [PATCH] Revise README for RFSystemsCookbook structure Updated README.md to reflect the structure and details of the RFSystemsCookbook Rust projects, including descriptions of directories and files. --- README.md | 37 ++++++++++++++++++++++++++++++++++--- 1 file changed, 34 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e6baa57..18fbef4 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,38 @@ -## Rust Projects -Rust Projects showcase application of the Worked Examples. +## Rust Projects: RFSystemsCookbook -#### Projects include; +This Rust Cookbook Projects include; +``` +rf-sic/ +├── Cargo.toml # Rust workspace +├── rust-backend/ +│ ├── src/ +│ │ ├── main.rs # Ratatui TUI entry point +│ │ ├── ui/ # Ratatui widgets, layouts, event loop +│ │ ├── rf/ # RF simulation engine (tpt-dsp, rustradio) +│ │ ├── problems/ # 50 problem modules (Rust-native solvers) +│ │ └── python_bridge/ # PyO3 bindings → Python backend +│ └── Cargo.toml +├── python-backend/ +│ ├── notebooks/ # Jupyter notebooks (scikit-rf, numpy, scipy) +│ ├── solvers/ # Python RF solvers (link budget, S-params) +│ └── requirements.txt +├── matlab-octave/ +│ ├── scripts/ # .m files (Octave-compatible) +│ └── results/ +├── docs/ +│ ├── NOTES.md # Private reasoning / reference model +│ ├── REPORTS.md # Research details & solution paths +│ ├── WHITEPAPER.md # Funding / standards justification +│ ├── latex/ +│ │ └── rf_sic_problems.tex # Shareable LaTeX problem compendium +│ └── problems_index.md # Tabular index of 50 problems +├── .github/workflows/ +│ ├── ci.yml # Rust + Python CI (test, lint, deny) +│ └── cd.yml # Release artefacts, Docker, docs +└── README.md +``` + +## For other Rust Projects go to: - RustWebM - A [Rust_WASM WebApp CrossPlatform Tool(Application) for WebSystems Management](../Projects/RustWebApp/README.md)