diff --git a/README.md b/README.md index 585d3a9..0dd8276 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,9 @@ 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 [more high-level 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). 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 +18,10 @@ 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, hosted + [here](https://documentation.irs.uni-stuttgart.de/projects/sat-rs/). It can be useful 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): diff --git a/satrs-mib/Cargo.toml b/satrs-mib/Cargo.toml index e1c66ad..a34d886 100644 --- a/satrs-mib/Cargo.toml +++ b/satrs-mib/Cargo.toml @@ -23,9 +23,9 @@ version = "1" optional = true [dependencies.satrs-core] -# version = "0.1.0-alpha.1" -git = "https://egit.irs.uni-stuttgart.de/rust/sat-rs.git" -branch = "main" +version = "0.1.0-alpha.1" +# git = "https://egit.irs.uni-stuttgart.de/rust/sat-rs.git" +# branch = "main" # rev = "35e1f7a983f6535c5571186e361fe101d4306b89" [dependencies.satrs-mib-codegen] diff --git a/satrs-mib/codegen/Cargo.toml b/satrs-mib/codegen/Cargo.toml index fc82778..cba83eb 100644 --- a/satrs-mib/codegen/Cargo.toml +++ b/satrs-mib/codegen/Cargo.toml @@ -20,9 +20,9 @@ quote = "1" proc-macro2 = "1" [dependencies.satrs-core] -# version = "0.1.0-alpha.1" -git = "https://egit.irs.uni-stuttgart.de/rust/sat-rs.git" -branch = "main" +version = "0.1.0-alpha.1" +# git = "https://egit.irs.uni-stuttgart.de/rust/sat-rs.git" +# branch = "main" # rev = "35e1f7a983f6535c5571186e361fe101d4306b89" [dev-dependencies]