From b89b4db1dbad992f8fd34936b7b3c1eede40dc88 Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Sun, 19 Feb 2023 18:32:06 +0100 Subject: [PATCH] improve core docs --- satrs-core/README.md | 1 + satrs-core/src/lib.rs | 16 ++++++++++------ 2 files changed, 11 insertions(+), 6 deletions(-) diff --git a/satrs-core/README.md b/satrs-core/README.md index 2735da8..94299c8 100644 --- a/satrs-core/README.md +++ b/satrs-core/README.md @@ -2,3 +2,4 @@ satrs-core ====== This crate contains the core components of the sat-rs framework. +You can find more information on [homepage](https://egit.irs.uni-stuttgart.de/rust/sat-rs) diff --git a/satrs-core/src/lib.rs b/satrs-core/src/lib.rs index fd456c3..3b87c69 100644 --- a/satrs-core/src/lib.rs +++ b/satrs-core/src/lib.rs @@ -1,12 +1,16 @@ //! # Core components of the sat-rs framework //! -//! This is a collection of Rust crates which can be used to build On-Board Software for remote -//! systems like satellites of rovers. It has special support for space tailored protocols -//! like the ones provided by CCSDS and ECSS. +//! You can find more information about the sat-rs framework on the +//! [homepage](https://egit.irs.uni-stuttgart.de/rust/sat-rs). //! -//! The crates can generally be used in a `no_std` environment, but some crates expect that the -//! [alloc](https://doc.rust-lang.org/alloc) crate is available to allow boxed trait objects. -//! These are used to supply user code to the crates. +//! ## Overview +//! +//! The core modules of this crate include +//! +//! - The [event manager][event_man] module which provides a publish and +//! and subscribe to route events. +//! - The [pus] module which provides special support for projects using +//! the [ECSS PUS C standard](https://ecss.nl/standard/ecss-e-st-70-41c-space-engineering-telemetry-and-telecommand-packet-utilization-15-april-2016/). #![no_std] #![cfg_attr(doc_cfg, feature(doc_cfg))] #[cfg(feature = "alloc")]