go-spectre/README.md

18 lines
748 B
Markdown

# Spectre
[![Go Reference](https://pkg.go.dev/badge/go.jolheiser.com/go-spectre.svg)](https://pkg.go.dev/go.jolheiser.com/go-spectre)
A Go implementation of [spectre](https://spectre.app).
Currently, it passes a sub-set of the [CLI tests](https://gitlab.com/spectre.app/cli/-/blob/main/spectre_tests.xml).
It also passes the JS [sanity check](https://gitlab.com/spectre.app/www/-/blob/306704b129a2c43544af202b8b6fb5c7e665ce66/assets/js/mpw-js/mpw.js#L205).
This is because I've only implemented v3 of the algorithm and the main pieces.
[Implementation breakdown](IMPLEMENTATION.md)
Generally code wouldn't split across files this liberally. It's done here for ease of reference.
## License
[GPLv3](LICENSE) - same as the algorithm author