rename subfolders, add more READMEs

2022-11-20 19:04:08 +01:00 · 2022-11-20 19:04:08 +01:00 · 2e249ec086
commit 2e249ec086
parent db6fb0ab5c
43 changed files with 12 additions and 3 deletions
--- a/Cargo.toml
+++ b/Cargo.toml
@ -1,7 +1,7 @@
 [workspace]

 members = [
-    "fsrc-core",
+    "satrs-core",
    "spacepackets",
-    "fsrc-example"
+    "satrs-example"
 ]
--- a/README.md
+++ b/README.md
@ -1,5 +1,14 @@
-Rust Flight Software Framework Launchpad
+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:
+
+1. The [`spacepackets`](https://egit.irs.uni-stuttgart.de/rust/spacepackets) crate which contains
+   basic ECSS and CCSDS packet protocol implementations.
+2. The [`fsrc-core`](https://egit.irs.uni-stuttgart.de/rust/fsrc-launchpad/src/branch/main/fsrc-core)
+   crate containing the core components of sat-rs
+3. The [`fscr-example`](https://egit.irs.uni-stuttgart.de/rust/fsrc-launchpad/src/branch/main/fsrc-example)
+   crate which shows a simple example on-board software using various sat-rs components.
--- a/satrs-core/CHANGELOG.md
+++ b/satrs-core/CHANGELOG.md
--- a/satrs-core/Cargo.toml
+++ b/satrs-core/Cargo.toml
--- a/satrs-core/images/event_man_arch.graphml
+++ b/satrs-core/images/event_man_arch.graphml
--- a/satrs-core/images/event_man_arch.png
+++ b/satrs-core/images/event_man_arch.png
--- a/satrs-core/src/error.rs
+++ b/satrs-core/src/error.rs
--- a/satrs-core/src/event_man.rs
+++ b/satrs-core/src/event_man.rs
--- a/satrs-core/src/events.rs
+++ b/satrs-core/src/events.rs
--- a/satrs-core/src/executable.rs
+++ b/satrs-core/src/executable.rs
--- a/satrs-core/src/hal/host/mod.rs
+++ b/satrs-core/src/hal/host/mod.rs
--- a/satrs-core/src/hal/host/udp_server.rs
+++ b/satrs-core/src/hal/host/udp_server.rs
--- a/satrs-core/src/hal/mod.rs
+++ b/satrs-core/src/hal/mod.rs
--- a/satrs-core/src/lib.rs
+++ b/satrs-core/src/lib.rs
--- a/satrs-core/src/objects.rs
+++ b/satrs-core/src/objects.rs
--- a/satrs-core/src/params.rs
+++ b/satrs-core/src/params.rs
--- a/satrs-core/src/pool.rs
+++ b/satrs-core/src/pool.rs
--- a/satrs-core/src/pus/event.rs
+++ b/satrs-core/src/pus/event.rs
--- a/satrs-core/src/pus/event_man.rs
+++ b/satrs-core/src/pus/event_man.rs
--- a/satrs-core/src/pus/mod.rs
+++ b/satrs-core/src/pus/mod.rs
--- a/satrs-core/src/pus/verification.rs
+++ b/satrs-core/src/pus/verification.rs
--- a/satrs-core/src/tmtc/ccsds_distrib.rs
+++ b/satrs-core/src/tmtc/ccsds_distrib.rs
--- a/satrs-core/src/tmtc/mod.rs
+++ b/satrs-core/src/tmtc/mod.rs
--- a/satrs-core/src/tmtc/pus_distrib.rs
+++ b/satrs-core/src/tmtc/pus_distrib.rs
--- a/satrs-core/src/tmtc/tm_helper.rs
+++ b/satrs-core/src/tmtc/tm_helper.rs
--- a/satrs-core/tests/pools.rs
+++ b/satrs-core/tests/pools.rs
--- a/satrs-core/tests/pus_autogen_events.rs
+++ b/satrs-core/tests/pus_autogen_events.rs
--- a/satrs-core/tests/pus_events.rs
+++ b/satrs-core/tests/pus_events.rs
--- a/satrs-core/tests/pus_verification.rs
+++ b/satrs-core/tests/pus_verification.rs
--- a/satrs-example/Cargo.toml
+++ b/satrs-example/Cargo.toml
--- a/satrs-example/README.md
+++ b/satrs-example/README.md
--- a/satrs-example/pyclient/.gitignore
+++ b/satrs-example/pyclient/.gitignore
--- a/satrs-example/pyclient/main.py
+++ b/satrs-example/pyclient/main.py
--- a/satrs-example/pyclient/requirements.txt
+++ b/satrs-example/pyclient/requirements.txt
--- a/satrs-example/pyclient/seqcnt.txt
+++ b/satrs-example/pyclient/seqcnt.txt
--- a/satrs-example/pyclient/tmtc_conf.json
+++ b/satrs-example/pyclient/tmtc_conf.json
--- a/satrs-example/src/bin/client.rs
+++ b/satrs-example/src/bin/client.rs
--- a/satrs-example/src/bin/obsw/ccsds.rs
+++ b/satrs-example/src/bin/obsw/ccsds.rs
--- a/satrs-example/src/bin/obsw/main.rs
+++ b/satrs-example/src/bin/obsw/main.rs
--- a/satrs-example/src/bin/obsw/pus.rs
+++ b/satrs-example/src/bin/obsw/pus.rs
--- a/satrs-example/src/bin/obsw/tmtc.rs
+++ b/satrs-example/src/bin/obsw/tmtc.rs
--- a/satrs-example/src/bin/test.rs
+++ b/satrs-example/src/bin/test.rs
--- a/satrs-example/src/lib.rs
+++ b/satrs-example/src/lib.rs