I liked this code a lot, but I have a new version with a many new features

[sean-galloway]

I liked this code a lot, but I have a new version with many new features. I use a tool called "Sourcery" to code. It helps a lot and points out code that needs to be refactored. I refactored the code while I was adding new features. These new features may be unique to my usage model, but I wanted to let you know. My base repo is here:
https://github.com/sean-galloway/RTLDesignSherpa

The new script is here:
https://github.com/sean-galloway/RTLDesignSherpa/blob/main/bin/vcd2wavedrom2.py

I have a pretty detailed markdown for the script here:
https://github.com/sean-galloway/RTLDesignSherpa/blob/main/docs/mark_down/scripts/vcd2wavedrom2.md

If you have read this far, it creates a text config file that autodetects for clocks (currently, it just looks for 'clk,' but this could be improved) and sets the sample rate to that of the slowest clock. It is a good jumping-off point for the config; users can edit it how they like.

I'm using all the free tools for this project. I use GTKWave for the waveforms. In GTKWave, I can put labels, like "-write port," and then another level within the write port called "--write pointer and control." Using the '-' allows me to detect when a label needs to go into wavedrom and whether it is embedded in another label.

I want folks to be able to follow along with the waveforms. I also added a cycle count at the top of the waveforms that get generated. I can say, "In cycle six, the pointer does this."

I hope you are ok with me just boldly hacking into your code.