VH 1295 - Updated the README docs

README.md

@@ -43,18 +43,9 @@ V2X Hub is a communication, computation, and processing platform for V2I applica
 	* Aggregation of vehicle weather data for efficient communication to Transportation Management Entity for weather-responsive traffic management.
 	* Multi-Modal Intelligent Traffic Signal Systems (MMITSS) “intersection level” functions including J2735 Intersection Geometry (MAP) and J2735 Signal Phase and Timing (SPaT) broadcast manager, equipped vehicle tracker, priority request server, and interface to traffic signal controller.
 
-# Simulation Setup
-To support execution in a simulated environment, V2X-Hub is in the process of integrating with CDASim, a Co-Simulation tool built as an extension of Eclipse Mosiac. This extension will incorporate integration with several other platforms including CARMA-Platform and CARLA. The setup for this simply requires setting environment variables inside the V2X-Hub docker container.
- * **SIMULATION_MODE** – Environment variable for enabling simulation components for V2X-Hub. If set to "true" or "TRUE" simulation components will be enable. Otherwise, simulation components will not be enabled.
- * **KAFKA_BROKER_ADDRESS** – Environment variable for storing Kafka broker connection string (including port).
- * **TIME_SYNC_TOPIC** – Environment variable for storing Kafka time sync topic.
- * **SIMULATION_IP** – Environment variable for storing IP address of CDASim application.
- * **SIMULATION_REGISTRATION_PORT** – Environment variable for storing port on CDASim that handles registration attempts.
- * **TIME_SYNC_PORT** – Environment varaible for storing port for receiving time sync messages from CDASim.
- * **V2X_PORT** – Environment variable for storing port for receiving v2x messages from CDASim
- * **SIM_V2X_PORT** – Environment variable for storing port for sending v2x messages to CDASim
- * **LOCAL_IP** – Environment variable for storing local IP of V2X Hub.
- * **INFRASTRUCTURE_ID** – Environment variable for storing infrastructure id of V2X Hub..
+## Deployment Configuration
+The instructions for deployment and configuration are located here: [Instructions](<configuration/README.md>)
+
 ## Release Notes
 The current version and release history of the V2X Hub software platform can be found here: [Release Notes](<docs/Release_notes.md>)
 

configuration/README.md

@@ -1,6 +1,5 @@
-## Deployment Configuration
-### Introduction
-This directory contains deployment configurations for deploying V2X-Hub on both ARM64(arm64) and x86(amd64) architectures. 
+## Introduction
+This directory contains deployment and configuration instructions for deploying V2X-Hub on both ARM64(arm64) and x86(amd64) architectures.
 ### Deployment Instructions
 Once downloaded, navigate to the configuration directory:
 ```
@@ -39,3 +38,16 @@ Close the Privacy Error tab and wait for the initial V2X Hub tab to finish loadi
 Enter the login credentials you created in step 5b and login.
 
 Installation complete!
+
+### Simulation Setup
+To support execution in a simulated environment, V2X-Hub is in the process of integrating with CDASim, a Co-Simulation tool built as an extension of Eclipse Mosiac. This extension will incorporate integration with several other platforms including CARMA-Platform and CARLA. The setup for this simply requires setting environment variables inside the V2X-Hub docker container.
+ * **SIMULATION_MODE** – Environment variable for enabling simulation components for V2X-Hub. If set to "true" or "TRUE" simulation components will be enable. Otherwise, simulation components will not be enabled.
+ * **KAFKA_BROKER_ADDRESS** – Environment variable for storing Kafka broker connection string (including port).
+ * **TIME_SYNC_TOPIC** – Environment variable for storing Kafka time sync topic.
+ * **SIMULATION_IP** – Environment variable for storing IP address of CDASim application.
+ * **SIMULATION_REGISTRATION_PORT** – Environment variable for storing port on CDASim that handles registration attempts.
+ * **TIME_SYNC_PORT** – Environment varaible for storing port for receiving time sync messages from CDASim.
+ * **V2X_PORT** – Environment variable for storing port for receiving v2x messages from CDASim
+ * **SIM_V2X_PORT** – Environment variable for storing port for sending v2x messages to CDASim
+ * **LOCAL_IP** – Environment variable for storing local IP of V2X Hub.
+ * **INFRASTRUCTURE_ID** – Environment variable for storing infrastructure id of V2X Hub..