From 99fbbac9e3f00aa2c239652b3564672244db9f08 Mon Sep 17 00:00:00 2001 From: Ibo Khaled Date: Tue, 13 Feb 2024 13:18:40 +0100 Subject: [PATCH] Update README.md Add getting started section --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index e741b37..14ce5a4 100644 --- a/README.md +++ b/README.md @@ -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;