Skip to content

Commit

Permalink
Update documentation to cover new config command
Browse files Browse the repository at this point in the history
  • Loading branch information
machitgarha committed Apr 11, 2023
1 parent b8cc44f commit 6dd24a5
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ There are three methods to install Parvaj: Use the AppImage bundle, use the Phar
- GHDL
- GTKWave

Having a Linux distribution, installing these should be easy. On Fedora 35, for example, you could simply do:
Having a GNU/Linux distribution, installing these should be easy. On Fedora 35, for example, you could simply do:

```bash
sudo dnf install ghdl gtkwave
Expand Down Expand Up @@ -116,6 +116,16 @@ parvaj simulate --help
parvaj simulate test_clock_generator -o stop-time=3ns -o vcd-nodate
```
### Other Commands
Although Parvaj is designed to work mostly config-free, you can configure a few things:
- `gtkwave.cmdline`: If set, this command is used to run GTKWave. This is useful if you want to use a different application for viewing waveforms, or having problems with the default invocation command.
For instance, on MacOS, you can set it to `open`.
- `ghdl.version`: GHDL version should be auto-detected, but this sets its major version.
## Platform Support
Tested platforms include:
Expand Down

0 comments on commit 6dd24a5

Please sign in to comment.