Skip to content

Commit

Permalink
gifs and nice things
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 26, 2024
1 parent 2d636e1 commit 09d5f6c
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 7 deletions.
9 changes: 8 additions & 1 deletion .devcontainer/prebuilt/devcontainer.json
Original file line number Diff line number Diff line change
@@ -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"
}
1 change: 0 additions & 1 deletion .devcontainer/ubuntu-gui/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,4 @@
"label": "desktop"
}
}
// "onCreateCommand": "bash /workspaces/openroad-codespace/update-config.sh"
}
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Binary file added img/configure_codespace.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/create_codespace.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 09d5f6c

Please sign in to comment.