Skip to content

Commit

Permalink
Update README.md with instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
HYwooo committed Oct 26, 2024
1 parent ba786e7 commit 65a9c0c
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,16 @@

> ❗ For educational purposes only.

## :rocket:Usage

### :one: GET the image
#### PULL from Github Packages

```bash
docker pull hywooo/bsv-wsl2
```
#### or BUILD the image

```bash
docker build -f Dockerfile -t hywooo/bsv-wsl2 .
```
Expand All @@ -32,21 +33,24 @@ docker run -it --name="bsv-wsl2" --hostname yourname -v //path/to/wsl2/yourfiles
bsvbuild.sh -bs Hello.bsv
# -e ./sim.out > /dev/stdout
# Hello World!
######
###############
### OR
bsvbuild.sh -vs Hello.bsv
# Hello World!
# mkTb.v:41: $finish(1) called at 5 (1s)
######
###############
bsc
# Usage:
# bsc -help ...
# ...
######
###############
gtkwave
# GTKWave Analyzer v3.3.116 (w)1999-2023 BSI
# ...
```
> :sparkles: NOTED: With `VcXsrv` installed, you are enabled to interact with `gtkwave` on Windows w/o any VNCs.
>
> <center><img src="https://github.com/HYwooo/Docker-BSV-WSL2/blob/master/.asset/gtkwave.png?raw=true" style="zoom: 33%;" /></center>
### 🎉 ENJOY!

Expand Down

0 comments on commit 65a9c0c

Please sign in to comment.