Skip to content

Commit

Permalink
Update 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 487482c commit 5bff15f
Showing 1 changed file with 10 additions and 16 deletions.
26 changes: 10 additions & 16 deletions .devcontainer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,17 @@ The goal is to provide a web browser experience of the OpenROAD GUI. Solution wo

## User


1. First time users are encourage to read the tutorial [creating a codespace for a repository](https://docs.github.com/en/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository). Follow this tutorial to create a codespace from the ORFS repository. Select `ubuntu2204-gui` in the `Dev container configuration` field.
2. Currently to run the OpenROAD GUI in the web browser, you need to [install VSCode](https://code.visualstudio.com/docs/setup/setup-overview).
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`

## 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.




# Development loop

https://code.visualstudio.com/docs/devcontainers/create-dev-container#_full-configuration-edit-loop


# devcontainer json reference:

https://containers.dev/implementors/json_reference/

# ORFS Docker

OpenROAD and OpenROAD Flow Scripts provide a docker image generation script `etc/DockerHelper.sh`, which is reused 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/)

0 comments on commit 5bff15f

Please sign in to comment.