blob42
/
rusty-man
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
master
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'fdabe11c4a'
${ noResults }
rusty-man/README.md

28 lines
685 B
Markdown
Raw Normal View History Unescape Escape

Initial project scaffolding This patch contains the initial project scaffolding, based on the files generated by cargo new.
5 years ago
<!---
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
Add --viewer option and plain text viewer 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.
4 years ago
This crate supports Rust 1.40 or later.
Initial project scaffolding This patch contains the initial project scaffolding, based on the files generated by cargo new.
5 years ago
## 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/