diff --git a/README.md b/README.md index 3809d1f..47bf71d 100644 --- a/README.md +++ b/README.md @@ -17,17 +17,6 @@ You might need to set the [`CROSS_CONTAINER_ENGINE`](https://github.com/cross-rs and [`CROSS_ROOTLESS_CONTAINER_ENGINE`](https://github.com/cross-rs/cross/blob/main/docs/environment_variables.md#configuring-cross-with-environment-variables) variables manually before calling cross. -The OPS-SAT software filesystem handling will determine a home path at the start of the software. -This home path is used for various mechanisms inside the OPS-SAT infrastructure. - -Currently, there are 3 possible configurations: - -1. If the software is built with the `host` feature, the HOME path will be the current path the - software is run at. -2. If the `host` feature is not set and the `/home/exp278` folder exists, that folder will be - the home directory. -3. Otherwise, the default OS home directory will be the home directory. - ### Debug Build ```sh @@ -108,3 +97,28 @@ the following configuration: ``` You can run `pyclient.py -T` or `pyclient.py -h` for more information on the client application. + +## Knowledge Base + +### Home Path Handling + +The OPS-SAT software filesystem handling will determine a home path at the start of the software. +This home path is used for various mechanisms inside the OPS-SAT infrastructure. + +Currently, there are 3 possible configurations: + +1. If the software is built with the `host` feature, the HOME path will be the current path the + software is run at. +2. If the `host` feature is not set and the `/home/exp278` folder exists, that folder will be + the home directory. +3. Otherwise, the default OS home directory will be the home directory. + +### Application Shutdown Handling + +The application can be stopped by creating a `stop-experiment` file either in the home path +specified in the previous section, or inside the temporary folder. There is also an action command +available to stop the application. + +### Camera Handling + +TODO