Skip to content

Commit

Permalink
Add instructions for desktop environment setup (#55)
Browse files Browse the repository at this point in the history
  • Loading branch information
Thomas-Neill authored Nov 6, 2023
1 parent 2f2abe4 commit 2412e1d
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 12 deletions.
28 changes: 18 additions & 10 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,24 +16,32 @@
"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}"
],
"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"
]
}
}
}
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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`
Expand Down

0 comments on commit 2412e1d

Please sign in to comment.