diff --git a/README.md b/README.md new file mode 100644 index 0000000..dcbb4b9 --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +Quick hack for relaying local ros topics to a remote rosbridge master. + +This works on ros-melodic, you can change it to build using other ros-distro's easily by editing the Dockerfile. + +To run, make sure you have docker installed and simply run the command `docker compose up --build` from the root +of this repository. You can also run `docker compose up --build --detach` to run it in the background. + +Configuration is set in the `docker-compose.yaml`. This includes what topics to relay, and a TOPIC_PREFIX +which should be unique for each drone.