From dcd55ea6e1de8f10ec786a4549a1ab08fe244ba6 Mon Sep 17 00:00:00 2001 From: KIYINI Joseph Balamazze <73903994+josephkb87@users.noreply.github.com> Date: Fri, 25 Sep 2026 00:48:36 +0300 Subject: [PATCH] Revise README for Rust Projects overview Updated the README to reflect a more general overview of Rust projects and their organization. --- README.md | 38 ++++---------------------------------- 1 file changed, 4 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 18fbef4..f348362 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,8 @@ -## Rust Projects: RFSystemsCookbook +## Rust Projects: -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 -``` +These Rust Projects consist of different Projects made with Rust. -## For other Rust Projects go to: +## Go to for: - RustWebM - A [Rust_WASM WebApp CrossPlatform Tool(Application) for WebSystems Management](../Projects/RustWebApp/README.md) @@ -52,7 +22,7 @@ rf-sic/ - [**DocsGen**](https://github.com/josephkb87/docsgen) - A Documentation Generator made with Rust and OCaml. -#### [Docs](..docs/) +## [Docs](..docs/) * [About Me](https://github.com/josephkb87) * [AUTHORS](../docs/AUTHORS.md)