Update README.md #33
Update README.md #33
Conversation
README.md
Outdated
| @@ -5,6 +5,22 @@ | |||
| # 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. \ | |||
| **IMPORTANT NOTICE:** As of late 2023, master is broken (see [#30](https://github.com/matwey/libopenvizsla/pull/30#issuecomment-1501915611)). Use Tag/Release 0.1.1 instead. | |||
There was a problem hiding this comment.
Hi.
First of all, thank you for the contribution.
If you feel that something is broken, please open new issue instead.
There was a problem hiding this comment.
The current master gets out of sync and I do not really have time to debug it. As an intermediate solution, you can either use earlier master version or if you want to benefit from new bitstream use the original version of #30 (i.e. prior to master changes) that I pushed to a branch at my fork: https://github.com/desowin/libopenvizsla/tree/update-bitstream-working
There was a problem hiding this comment.
The bug mentioned here is fixed in #34
README.md
Outdated
| 3. Run Wireshark and start capturing | ||
|
|
||
| ### Windows | ||
| 1. Make sure `FTDI D2XX` drivers are installed |
There was a problem hiding this comment.
There is no need for FTDI drivers because libusbK is being used. The FTDI drivers may only be necessary if you are building brand new OpenVizsla and have to program the EEPROM (but this is not supported here, only in ov_ftdi python code).
There was a problem hiding this comment.
Thanks for the hint, removed!
Add getting started section
IboKhaled
force-pushed
the
feature/updateDocumentation
branch
from
2922a79 to
99fbbac
Compare
|
Sorry for not responding for so long. Thank you for the amazing project, it has worked very well and without issues for me after getting it all set up! |
|
Thanks |
Add getting started section
Add notice that master is broken as of late 2023