updated README with instructions

Author: Aksont

README.md

@@ -1,9 +1,14 @@
-# Yamcs QuickStart
+# Yamcs (QuickStart) integration with SATLINK PoC
 
-This repository holds the source code to start a basic Yamcs application that monitors a simulated spacecraft in low earth orbit.
+This branch / repository holds the source code of the integration between Yamcs and SATLINK's Ground and Space segments.
 
-You may find it useful as a starting point for your own project.
+The integration implements encryption of TCs comming from Yamcs using SATLINK's Ground segment.
+These TCs are decrypted in OBS using Space segment.
 
+OBS sends TM, which is encrypted using Space segment, and later decrypted on Yamcs side using Ground segment. 
+
+SATLINK files were minimaly customized by selecting which functionalities will be utilized, and for providing additional debugging options.
+Two custom Yamcs classes were made to be able to encrypt/decrypt TC/TM Frames before sending them to OBS.
 
 ## Prerequisites
 
@@ -12,10 +17,27 @@ You may find it useful as a starting point for your own project.
 
 A copy of Maven is also required, however this gets automatically downloaded an installed by using the `./mvnw` shell script as detailed below.
 
+## Running the integration
+
+1. Run Ground segment
+2. Run Yamcs
+3. Run OBS script
+4. Send TCs through Yamcs Web and track TM updates
+
+## Running Ground segment
+
+Inside _ground_ folder:
+
+    docker compose up
+
+If running the project again:
 
-## Running Yamcs
+    docker compose down -v
+    docker compose up
 
-Here are some commands to get things started:
+## Running Yamcs (same as QuickStart)
+
+Inside root folder:
 
 Compile this project:
 
@@ -24,41 +46,15 @@ Compile this project:
 Start Yamcs on localhost:
 
     ./mvnw yamcs:run
-
-Same as yamcs:run, but allows a debugger to attach at port 7896:
-
-    ./mvnw yamcs:debug
 
 Delete all generated outputs and start over:
 
     ./mvnw clean
 
 This will also delete Yamcs data. Change the `dataDir` property in `yamcs.yaml` to another location on your file system if you don't want that.
 
+## Running OBS script
 
-## Telemetry
-
-To start pushing CCSDS packets into Yamcs, run the included Python script:
-
-    python simulator.py
-
-This script will send packets at 1 Hz over UDP to Yamcs. There is enough test data to run for a full calendar day.
-
-The packets are a bit artificial and include a mixture of HK and accessory data.
-
-## Other useful generation of simulated data
-
-Generate test images in a Yamcs bucket (image number and image url are available as Yamcs parameters):
-
-    python simulator/images/generate_images.py 
-
-## Telecommanding
-
-This project defines a few example CCSDS telecommands. They are sent to UDP port 10025. The simulator.py script listens to this port. Commands have no side effects. The script will only count them.
-
-
-## Bundling
-
-Running through Maven is useful during development, but it is not recommended for production environments. Instead bundle up your Yamcs application in a tar.gz file:
+Inside _obs_ folder:
 
-    ./mvnw package
+    python3 obs-script.py