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 27, 2024
1 parent 4b68f31 commit c2c61f3
Showing 1 changed file with 17 additions and 10 deletions.
27 changes: 17 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,28 @@

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).
## Creating a Codespace

## User
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)

1. Create a codespace from this repository.
1. Create a codespace from this repository

![create](https://github.com/antmicro/openroad-codespace/blob/mczyz/dev/img/create_codespace.gif)

2. Select `ubuntu gui` in the `Dev container configuration` field

![configure](https://github.com/antmicro/openroad-codespace/blob/mczyz/dev/img/configure_codespace.gif)

3. Connect to the generated codespace
4. At the bottom, there should be tab `PORTS`, where you will find the `Forwarded Address`. Follow this link to connect to NoVNC
3. Click "Create codespace" and after a few minutes, the codespace should be ready for use

## Using the Codespace

1. At the bottom, there should be tab `PORTS`, where you will find the `Forwarded Address`. A link is provided, which you can follow to open the OpenROAD GUI

![open](https://github.com/antmicro/openroad-codespace/blob/mczyz/dev/img/open_vnc.gif)

5. NoVNC tab should open - default password is `vscode`.
6. Right-click on desktop and open Terminal and execute the following commands to run OpenROAD GUI
2. NoVNC tab should open - default password is `vscode`
3. Right-click on desktop and open Terminal and execute the following commands to run OpenROAD GUI

```
cd /OpenROAD-flow-scripts/flow
Expand All @@ -29,13 +32,13 @@ make
make gui_final
```

### VSCode
## VSCode

1. You can also use VSCode to connect to Codespaces
2. [Install VSCode](https://code.visualstudio.com/docs/setup/setup-overview).
2. [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. Press `Ctrl+Shift+P` and select `Codespaces:Connect to Codespace`
5. Open a web browser and connect to url: `localhost:6080`.
5. Open a web browser and connect to url: `localhost:6080`

## Developer

Expand All @@ -45,3 +48,7 @@ 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/)
* [Desktop lite feature](https://github.com/microsoft/vscode-dev-containers/blob/main/script-library/docs/desktop-lite.md)

### Desktop-lite feature

The desktop-lite feature is provided by the [devcontainers organization](https://github.com/devcontainers/features/tree/main/src/desktop-lite). In this repo, a modified version of the feature is used via the [update-link] script.

0 comments on commit c2c61f3

Please sign in to comment.