update README
This commit is contained in:
parent
42b2ed486f
commit
b217654d73
34
README.md
34
README.md
@ -4,15 +4,29 @@ sat-rs launchpad
|
||||
This is the prototyping repository for the initial version of a
|
||||
Rust Flight Software Framework.
|
||||
|
||||
Currently, it contains the following major subcrates:
|
||||
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.
|
||||
|
||||
1. The [`spacepackets`](https://egit.irs.uni-stuttgart.de/rust/spacepackets) crate which contains
|
||||
basic ECSS and CCSDS packet protocol implementations.
|
||||
2. The [`satrs-core`](https://egit.irs.uni-stuttgart.de/rust/satrs-launchpad/src/branch/main/satrs-core)
|
||||
crate containing the core components of sat-rs
|
||||
3. The [`satrs-example`](https://egit.irs.uni-stuttgart.de/rust/satrs-launchpad/src/branch/main/satrs-example)
|
||||
crate which shows a simple example on-board software using various sat-rs components.
|
||||
# Overview
|
||||
|
||||
The [`satrs-example-stm32f3-disco`](https://egit.irs.uni-stuttgart.de/rust/satrs-example-stm32f3-disco)
|
||||
crate contains an example of how components can be used in a bare-metal system with constrained
|
||||
resources.
|
||||
This project currently contains following crates:
|
||||
|
||||
* [`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):
|
||||
Example of a simple example on-board software using various sat-rs components which can be run
|
||||
on a host computer or on any system with a standard runtime like a Raspberry Pi.
|
||||
* [`satrs-example-stm32f3-disco`](https://egit.irs.uni-stuttgart.de/rust/satrs-example-stm32f3-disco)
|
||||
:Example of a simple example on-board software using sat-rs components on a bare-metal system
|
||||
with constrained resources.
|
||||
|
||||
# Related projects
|
||||
|
||||
In addition to the crates in this repository, the sat-rs project also maintains several
|
||||
other libraries.
|
||||
|
||||
* [`spacepackets`](https://egit.irs.uni-stuttgart.de/rust/spacepackets): Basic ECSS and CCSDS
|
||||
packet protocol implementations. This repository is re-expored in the
|
||||
[`satrs-core`](https://egit.irs.uni-stuttgart.de/rust/satrs-launchpad/src/branch/main/satrs-core)
|
||||
crate.
|
||||
|
Loading…
Reference in New Issue
Block a user