Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dpc/text-minimap
Generate text minimap/preview using Braille Patterns
https://github.com/dpc/text-minimap
braille command-line command-line-tool graphics library text utility
Last synced: 9 days ago
JSON representation
Generate text minimap/preview using Braille Patterns
- Host: GitHub
- URL: https://github.com/dpc/text-minimap
- Owner: dpc
- License: mpl-2.0
- Created: 2017-04-25T03:01:57.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-01-17T21:47:19.000Z (almost 4 years ago)
- Last Synced: 2024-10-18T07:28:52.556Z (19 days ago)
- Topics: braille, command-line, command-line-tool, graphics, library, text, utility
- Language: Rust
- Size: 13.7 KB
- Stars: 24
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MPL2
Awesome Lists containing this project
README
# text-minimap - Generate text minimap/preview using Braille Patterns
Library and command-line utility to efficiently generate minimap/preview
of a given text.
## Status
* [x] Efficient io and streaming
* [x] Multiple scaling settings
* [ ] Tab (`\t`) width support
* [ ] Soft-wrapping on text-width support
* [ ] C API
## Alternatives
* [wfxr/code-minimap](https://github.com/wfxr/code-minimap) - seems also written in Rust and with more effort put into it, so you probably should prefer it over this project; probably - I had no time to check the details myself;
## Installing
If you don't have rust compiler and cargo installed follow instructions on
https://www.rustup.rs/ .
Afterwards:
```
cargo install text-minimap
```
## Using
Check `text-minimap --help` output.
## Verification Recommendation
To help with the maintaince, the ownership of this crate is potentially shared between multiple developers.
It is recommend to always use [cargo-crev](https://github.com/crev-dev/cargo-crev/tree/master/cargo-crev)
to verify trustworthiness of each of your dependencies, including this one.