diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 328f74f8..623f8055 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -16,9 +16,17 @@ "ROS_LOCALHOST_ONLY": "1", "ROS_DOMAIN_ID": "42" }, + // comment out if not on Linux; use VNC instead "mounts": [ "source=/tmp/.X11-unix,target=/tmp/.X11-unix,type=bind,consistency=cached" ], + /*"features": { + "desktop-lite": { + "password": "vscode", + "webPort": "6080", + "vncPort": "5901" + } + }*/ "runArgs": [ "--net=host", "-e", "DISPLAY=${env:DISPLAY}" @@ -26,14 +34,14 @@ "forwardPorts": [ 6080 ], - "postCreateCommand": "/usr/local/bin/bashrc_setup.sh", - "customizations": { - "vscode": { - "extensions": [ - "ms-python.python", - "ms-vscode.cmake-tools", - "ms-azuretools.vscode-docker" - ] - } - } + "postCreateCommand": "/usr/local/bin/bashrc_setup.sh", + "customizations": { + "vscode": { + "extensions": [ + "ms-python.python", + "ms-vscode.cmake-tools", + "ms-azuretools.vscode-docker" + ] + } + } } \ No newline at end of file diff --git a/README.md b/README.md index 4b6e9ff0..51886e1d 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # UAV Forge's ROS2 package for GN&C and Aerial Imagery Object Detection. ## Dev Container Setup (one time setup) -1. Ensure you have Docker and X-11 forwarding installed on your device (google this) -2. Clone the repo and edit devcontainer.json accordingly for your X-11 setup +1. Ensure you have Docker and X-11 forwarding installed on your device. (google this) +2. Clone the repo and edit devcontainer.json accordingly for your X-11 setup. If you're on an non-linux OS you can also just comment out the lines for mounting the X socket and uncomment the lines for the "desktop-lite" below. Then by going to `localhost:6080` and entering the password `vscode` you should be able to access a desktop environment through your browser if necessary. 3. In VSCode, first run `python3 setup_image.py` (alternatively run `echo "FROM t0mmyn/uavf_2024" > .devcontainer/Dockerfile` to download from a mirrored x86 image) 4. Then open the command palette (cmd/ctrl+shift+p) and run `rebuild and reopen in dev container` 5. To verify your setup, run `run_tests.sh`