From 5273e0d7e777a00323f36fb305cf4106dcfb2493 Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Mon, 8 Apr 2024 19:23:46 +0200 Subject: [PATCH] README --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index 64668a7..d9202ea 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,26 @@ ESA OPS-SAT Rust experiment ======== This is the primary repository for the ESA OPS-SAT experiment. + +## Pre-Requisites + +- Containerization provider like docker or podman installed +- [`cross`](https://github.com/cross-rs/cross) package installed + +## Build + +```sh +cross build +``` + +## Documentation + +The [wiki](https://opssat1.esoc.esa.int/projects/experimenter-information/wiki) +appears to be a useful source for documentation. + +- [OBSW documents](https://opssat1.esoc.esa.int/projects/experimenter-information/dmsf?folder_id=7) +-[Cross-compiling SEPP](https://opssat1.esoc.esa.int/projects/experimenter-information/wiki/Cross-compiling_SEPP_application) +- [TMTC infrastructure](https://opssat1.esoc.esa.int/projects/experimenter-information/wiki/Live_TM_TC_data) +- [Submitting an Experiment](https://opssat1.esoc.esa.int/projects/experimenter-information/wiki/Building_and_submitting_your_application_to_ESOC) +- [Building with Yocto and Docker](https://opssat1.esoc.esa.int/projects/experimenter-information/wiki/Building_an_application_locally_using_Yocto_Toolchain_in_a_Docker) +- [SPP over CAN](https://opssat1.esoc.esa.int/projects/experimenter-information/wiki/SPP_over_CAN_communication)