Skip to content

Commit

Permalink
Expand README
Browse files Browse the repository at this point in the history
Signed-off-by: Michal Czyz <[email protected]>
  • Loading branch information
mczyz-antmicro committed Mar 20, 2024
1 parent 5bff15f commit 5062d3d
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 8 deletions.
5 changes: 3 additions & 2 deletions .devcontainer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,13 @@ The goal is to provide a web browser experience of the OpenROAD GUI. Solution wo
3. Open VSCode and install the [GitHub Codespaces](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces) extension
4. Connect to the generated codespace
5. Open a web browser and connect to url: `localhost:6080`
6. Alternatively, you can use a VNC client to connect to `localhost:5980`
6. Alternatively, you can use a VNC client to connect to `localhost:5901`

## Developer

OpenROAD Flow Scripts provide a docker image generation script `etc/DockerHelper.sh`, which is used here to build and publish the image to GH registry.

Useful resources:
* [Development loop](https://code.visualstudio.com/docs/devcontainers/create-dev-container#_full-configuration-edit-loop)
* [devcontainer json reference](https://containers.dev/implementors/json_reference/)
* [devcontainer JSON reference](https://containers.dev/implementors/json_reference/)
* [Desktop lite feature](https://github.com/microsoft/vscode-dev-containers/blob/main/script-library/docs/desktop-lite.md)
20 changes: 14 additions & 6 deletions .devcontainer/ubuntu2204-gui/devcontainer.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
{
"image": "ghcr.io/antmicro/openroad-flow-scripts/ubuntu22.04:latest",
"features": {
"ghcr.io/devcontainers/features/desktop-lite:1": {}
},
"forwardPorts": [6080],
"portsAttributes": {
"6080": {
"label": "desktop"
"desktop-lite": {
"password": "vscode",
"webPort": "6080",
"vncPort": "5901"
}
}
// "features": {
// "ghcr.io/devcontainers/features/desktop-lite:1": {}
// },
// "forwardPorts": [6080, 5901],
// "portsAttributes": {
// "6080": {
// "label": "desktop"
// }
// }

}

0 comments on commit 5062d3d

Please sign in to comment.