diff --git a/.devcontainer/prebuilt/devcontainer.json b/.devcontainer/prebuilt/devcontainer.json index 97f4653..5b5e33d 100644 --- a/.devcontainer/prebuilt/devcontainer.json +++ b/.devcontainer/prebuilt/devcontainer.json @@ -1,3 +1,10 @@ { - "image": "ghcr.io/antmicro/openroad-codespace:test" + "image": "ghcr.io/antmicro/openroad-codespace:test", + "forwardPorts": [6080], + "portsAttributes": { + "6080": { + "label": "desktop" + } + }, + // "onCreateCommand": "bash /workspaces/openroad-codespace/update-config.sh" } diff --git a/.devcontainer/ubuntu-gui/devcontainer.json b/.devcontainer/ubuntu-gui/devcontainer.json index fc98873..919cbce 100644 --- a/.devcontainer/ubuntu-gui/devcontainer.json +++ b/.devcontainer/ubuntu-gui/devcontainer.json @@ -9,5 +9,4 @@ "label": "desktop" } } - // "onCreateCommand": "bash /workspaces/openroad-codespace/update-config.sh" } diff --git a/README.md b/README.md index 413397e..f67ae42 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,18 @@ The goal is to provide a web browser experience of the OpenROAD GUI. Solution works with Firefox and Chrome. +First time Codespace users are encouraged 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). + ## 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 `ubuntu gui` in the `Dev container configuration` field -2. Connect to the generated codespace -3. At the bottom, there should be tab `PORTS`, where you will find the `Forwarded Address`. Follow this link -4. NoVNC tab should open - default password is `vscode`. -5. Right-click on desktop and open Terminal and execute the following commands to run OpenROAD GUI +1. Create a codespace from this repository. +![](https://github.com/antmicro/openroad-codespace/img/create_codespace.gif) +2. Select `ubuntu gui` in the `Dev container configuration` field +![](https://github.com/antmicro/openroad-codespace/img/configure_codespace.gif) +4. Connect to the generated codespace +5. At the bottom, there should be tab `PORTS`, where you will find the `Forwarded Address`. Follow this link +6. NoVNC tab should open - default password is `vscode`. +7. Right-click on desktop and open Terminal and execute the following commands to run OpenROAD GUI ``` cd /OpenROAD-flow-scripts/flow diff --git a/img/configure_codespace.gif b/img/configure_codespace.gif new file mode 100644 index 0000000..78fff9b Binary files /dev/null and b/img/configure_codespace.gif differ diff --git a/img/create_codespace.gif b/img/create_codespace.gif new file mode 100644 index 0000000..1a9869d Binary files /dev/null and b/img/create_codespace.gif differ