From e0b8280c41515fda37acb4584f30ac95c24126c1 Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Tue, 26 Sep 2023 18:21:10 +0200 Subject: [PATCH] bump README --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 585d3a9..5906c8b 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,11 @@ sat-rs This is the repository of the sat-rs framework. Its primary goal is to provide re-usable components to write on-board software for remote systems like rovers or satellites. It is specifically written -for the special requirements for these systems. +for the special requirements for these systems. You can find an overview of the project and the +link to the [sat-rs book](https://documentation.irs.uni-stuttgart.de/projects/sat-rs/) +at the [IRS documentation website](https://documentation.irs.uni-stuttgart.de/sat-rs.html). +It is recommended to read the book first before delving into the example application and the +API documentation. A lot of the architecture and general design considerations are based on the [FSFW](https://egit.irs.uni-stuttgart.de/fsfw/fsfw) C++ framework which has flight heritage @@ -16,6 +20,9 @@ and [EIVE](https://www.irs.uni-stuttgart.de/en/research/satellitetechnology-and- This project currently contains following crates: +* [`satrs-book`](https://egit.irs.uni-stuttgart.de/rust/sat-rs/src/branch/main/satrs-book): + Primary information resource in addition to the API documentation. It is recommended to read + this first before delving into the example application and the API documentation. * [`satrs-core`](https://egit.irs.uni-stuttgart.de/rust/satrs-launchpad/src/branch/main/satrs-core): Core components of sat-rs. * [`satrs-example`](https://egit.irs.uni-stuttgart.de/rust/satrs-launchpad/src/branch/main/satrs-example):