https://github.com/coastalwhite/wavedrom-rs
Beautiful Digital Timing Diagrams with Rust
Science Score: 13.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
○.zenodo.json file
-
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.9%) to scientific vocabulary
Keywords
Repository
Beautiful Digital Timing Diagrams with Rust
Basic Info
- Host: GitHub
- Owner: coastalwhite
- License: apache-2.0
- Language: Rust
- Default Branch: main
- Homepage: https://coastalwhite.github.io/wavedrom-rs
- Size: 1.45 MB
Statistics
- Stars: 85
- Watchers: 2
- Forks: 4
- Open Issues: 3
- Releases: 1
Topics
Metadata Files
README.md
wavedrom-rs 
A Rust Digital Timing Diagram generator based on WaveDrom
The wavedrom-rs crate provides an interface to shape beautiful Digital Timing
Diagrams into an SVG. It is almost completely compatible with the
WaveDrom project. It can be merged into document build tools,
continuous integration or be used as a one off to generate beautiful
diagrams.
There are currently four ways to use wavedrom-rs:
Features
- [x] All original WaveDrom Signal Types
- [x] Signal Groups
- [x] Arrows and Indicator Markers
- [x] Headers and Footers
- [x] Cycle Enumeration Markers
- [x] Editor Website through WASM
- [x] MdBook Preprocessor
- [x] Full Customization via Skins
Documentation
This project uses the same syntax for WaveJson as the original WaveDrom project. Therefore, the original Hitchhiker's Guide to WaveDrom is still a good introduction into several concepts of of WaveJson. Additionally, this repository maintains a reference book.
Testing
Tests are written in the ./tests directory and can be generated
using the ./tests/run.py scripts. This will generate a
result.html in the tests directory that contains all the rendered SVGs for
each json5 file in the ./tests directory.
```bash
Usage:
cd ./tests ./run [path/to/skin.json5] ```
Fuzzing
This project is fuzzed with cargo-fuzz. This improves the
stability of the project.
bash
cargo +nightly fuzz run wavejson-render
MSRV
This crate currently only compiles with Rust 1.70. To select that version use:
bash
rustup update 1.70 --no-self-update && rustup default 1.70
Contribution
Please report any bugs and possible improvements as an issue within this repository. Pull requests are also welcome.
License
Licensed under a MIT License. The demo website utilizes icons from Lucide which are licensed under an ISC license.
Owner
- Name: Gijs Burghoorn
- Login: coastalwhite
- Kind: user
- Location: Netherlands
- Company: Polars
- Website: gburghoorn.com
- Repositories: 103
- Profile: https://github.com/coastalwhite
Rusty Hardware and Security Guy 🦀
GitHub Events
Total
- Issues event: 1
- Watch event: 10
- Push event: 3
- Pull request event: 2
- Fork event: 1
Last Year
- Issues event: 1
- Watch event: 10
- Push event: 3
- Pull request event: 2
- Fork event: 1
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 5
- Total pull requests: 6
- Average time to close issues: 1 day
- Average time to close pull requests: 3 days
- Total issue authors: 4
- Total pull request authors: 2
- Average comments per issue: 1.0
- Average comments per pull request: 0.17
- Merged pull requests: 4
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 1
- Average time to close issues: N/A
- Average time to close pull requests: less than a minute
- Issue authors: 0
- Pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 0.0
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- johnblommers (2)
- marwinkirchhofs (1)
- TheZoq2 (1)
- dshemnv (1)
- coastalwhite (1)
Pull Request Authors
- coastalwhite (5)
- paspf (2)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 2
-
Total downloads:
- cargo 3,168 total
-
Total dependent packages: 1
(may contain duplicates) -
Total dependent repositories: 0
(may contain duplicates) - Total versions: 2
- Total maintainers: 1
crates.io: wavedrom
A Pure Rust Digital Timing Diagram Generator based on WaveDrom-JS
- Homepage: https://github.com/coastalwhite/wavedrom-rs
- Documentation: https://docs.rs/wavedrom/
- License: MIT OR Apache-2.0
-
Latest release: 0.1.0
published over 2 years ago
Rankings
Maintainers (1)
crates.io: mdbook-wavedrom-rs
A MdBook preprocessor for WaveDrom Digital Timing Diagrams
- Homepage: https://github.com/coastalwhite/wavedrom-rs
- Documentation: https://docs.rs/mdbook-wavedrom-rs/
- License: MPL-2.0
-
Latest release: 0.1.0
published over 2 years ago
Rankings
Maintainers (1)
Dependencies
- actions/checkout v3 composite
- actions/checkout v3 composite
- arbitrary 1.3.0
- block-buffer 0.10.4
- cc 1.0.79
- cfg-if 1.0.0
- cpufeatures 0.2.8
- crypto-common 0.1.6
- derive_arbitrary 1.3.1
- digest 0.10.7
- generic-array 0.14.7
- jobserver 0.1.26
- json5 0.4.1
- libc 0.2.147
- libfuzzer-sys 0.4.6
- once_cell 1.18.0
- pest 2.7.0
- pest_derive 2.7.0
- pest_generator 2.7.0
- pest_meta 2.7.0
- proc-macro2 1.0.63
- quote 1.0.29
- serde 1.0.166
- serde_derive 1.0.166
- sha2 0.10.7
- syn 2.0.23
- thiserror 1.0.40
- thiserror-impl 1.0.40
- ttf-parser 0.19.1
- typenum 1.16.0
- ucd-trie 0.1.5
- unicode-ident 1.0.10
- version_check 0.9.4