diff --git a/README.md b/README.md index cba0bbe..4fb64d3 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,18 @@ # XbeeMav -## Usage: +## Usage -- To run xbee_mav and ros master as a docker pod, use: +To run xbee_mav and ros master as a docker pod, use: - `docker compose -f docker-compose-test-stadalone.yml up --build` -- To run xbee_mav as an exclusive service to flash xbee devices, use: + +To run xbee_mav as an exclusive service to flash xbee devices, use: - `docker compose -f docker-compose-flash-device.yml up --build` -Note: The xbee config file is located in: `/xbeemav/Resources/XBee_Config.xml`. -This setup assumes the xbee is attached to /dev/ttyUSB0 and programmed to work at a baud rate of 230400. + +#### Note: The xbee config file is located in: +- `/xbeemav/Resources/XBee_Config.xml`. +#### This setup assumes the xbee is attached to `/dev/ttyUSB0` and programmed to work at a baud rate of `230400`. + ## Description