diff --git a/README.md b/README.md index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..df1eb9fd7cf433be4efc1686c2576960cff84b7a 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,42 @@ +Here’s a well-structured README document explaining how to run the code: + +--- + +# README: Running the Code on Hades Server for creaitng plots for optitrack latency + +## Prerequisites +1. **VPN Connection** + Ensure that you are connected to the **WZL VPN**. This is required to access the Hades server. + +2. **SSH Access** + Use your credentials to connect to the Hades server. Replace `bgaldos` with your username in the following command: + ```bash + ssh -Y your_username@134.130.124.18 + ``` + +## Steps to Run the Code + +1. **Clone the Repository** + Once connected to the Hades server, copy the repository `controller_docker` using the `git clone` command: + ```bash + git clone https://git-ce.rwth-aachen.de/bruno.galdos/controller_docker.git + ``` + +2. **Build the Container** + Navigate into the cloned repository directory and build the container: + ```bash + cd controller_docker + bash docker_build + ``` + +3. **Run the Script** + After building the container, execute the script to start the application: + - Navigate into the `docker_run` directory: + ```bash + cd docker_run + ``` + - Run the following script: + ```bash + ./run_mocap_driver.sh + ``` +