Skip to content

Commit

Permalink
Merge pull request #33 from IboKhaled/feature/updateDocumentation
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
matwey authored Feb 13, 2024
2 parents 3c19e8a + 99fbbac commit bfb6849
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,20 @@
# libopenvizsla
An attempt to reimplement [OpenVizsla](http://openvizsla.org/) host software in plain C.

## Getting Started
This section describes how to get started with OpenVizsla and Wireshark.

### Linux
1. Build the project as described below
2. Copy the `ovextcap` executable to Wiresharks `extcap` directory
3. Run Wireshark and start capturing

### Windows
1. Use `Zadig` to install the `libusbK` driver for OpenVizsla
2. Download Windows release
3. Extract and copy all files from `bin` directory to Wiresharks `extcap` directory
4. Run Wireshark and start capturing

## Building
Following components are required to build libopenvizsla:
* [check] - unit testing framework for C;
Expand Down

0 comments on commit bfb6849

Please sign in to comment.