5ce0365c7f
This patch adds a new --viewer command line option that lets the user select a viewer that displays the documentation. It also adds a default viewer implementation that uses html2text to generate plain text from the HTML documentation. html2text requires the ptr_cast feature and we use the Option::as_deref method in the viewer implementation, so we have to update the minimum supported Rust version to 1.40.
28 lines
685 B
Markdown
28 lines
685 B
Markdown
<!---
|
|
SPDX-FileCopyrightText: 2020 Robin Krahl <robin.krahl@ireas.org>
|
|
SPDX-License-Identifier: MIT
|
|
-->
|
|
|
|
# rusty-man
|
|
|
|
A command-line interface for documentation generated by `rustdoc`.
|
|
|
|
## Minimum Supported Rust Version
|
|
|
|
This crate supports Rust 1.40 or later.
|
|
|
|
## Contact
|
|
|
|
For bug reports, patches, feature requests or other messages, please send a
|
|
mail to [rusty-man-dev@ireas.org][].
|
|
|
|
## License
|
|
|
|
This project is licensed under the [MIT License][].
|
|
|
|
`rusty-man` complies with [version 3.0 of the REUSE specification][reuse].
|
|
|
|
[rusty-man-dev@ireas.org]: mailto:dialog-rs-dev@ireas.org
|
|
[MIT license]: https://opensource.org/licenses/MIT
|
|
[reuse]: https://reuse.software/practices/3.0/
|