rust/sat-rs
rust/sat-rs
5
1
Fork 0
Code Issues 9 Pull Requests 1 Projects Releases 21 Wiki Activity

improve core docs

Browse Source
This commit is contained in:
Robin Müller 2023-02-19 18:32:06 +01:00
parent 666b7a61ec
commit b89b4db1db
No known key found for this signature in database
GPG Key ID: 11D4952C8CCEF814
2 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
satrs-core/README.md
View File

@ -2,3 +2,4 @@ satrs-core
====== ======
This crate contains the core components of the sat-rs framework. 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)

16
satrs-core/src/lib.rs
View File

@ -1,12 +1,16 @@
//! # Core components of the sat-rs framework //! # 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 //! You can find more information about the sat-rs framework on the
//! systems like satellites of rovers. It has special support for space tailored protocols //! [homepage](https://egit.irs.uni-stuttgart.de/rust/sat-rs).
//! like the ones provided by CCSDS and ECSS.
//! //!
//! The crates can generally be used in a `no_std` environment, but some crates expect that the //! ## Overview
//! [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. //! 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] #![no_std]
#![cfg_attr(doc_cfg, feature(doc_cfg))] #![cfg_attr(doc_cfg, feature(doc_cfg))]
#[cfg(feature = "alloc")] #[cfg(feature = "alloc")]