From 713b4e097b0784f234c44c733d4128181ece6d97 Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Wed, 27 Mar 2024 14:14:45 +0100 Subject: [PATCH] update the README --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c20b996..aaaee5c 100644 --- a/README.md +++ b/README.md @@ -8,12 +8,17 @@ sat-rs ========= -This is the repository of the sat-rs framework. Its primary goal is to provide re-usable components +This is the repository of the sat-rs library. 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. You can find an overview of the project and the link to the [more high-level sat-rs book](https://absatsw.irs.uni-stuttgart.de/projects/sat-rs/) at the [IRS software projects website](https://absatsw.irs.uni-stuttgart.de/projects/sat-rs/). +This is early-stage software. Important features are missing. New releases +with breaking changes are released regularly, with all changes documented inside respective +changelog files. You should only use this library if your are willing to work in this +environment. + A lot of the architecture and general design considerations are based on the [FSFW](https://egit.irs.uni-stuttgart.de/fsfw/fsfw) C++ framework which has flight heritage through the 2 missions [FLP](https://www.irs.uni-stuttgart.de/en/research/satellitetechnology-and-instruments/smallsatelliteprogram/flying-laptop/)