blob42/rusty-man
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
e1ef283159
rusty-man/README.md

28 lines
682 B
Markdown
Raw Normal View History

Initial project scaffolding This patch contains the initial project scaffolding, based on the files generated by cargo new.
2020-01-12 10:50:40 +00:00
<!---
SPDX-FileCopyrightText: 2020 Robin Krahl <robin.krahl@ireas.org>
SPDX-License-Identifier: MIT
-->
# rusty-man
Replace “interface” with “viewer” in description Previously, we called rusty-man a command-line interface for rustdoc documentation, but “viewer” is a more appropriate term.
2020-07-19 15:24:38 +00:00
A command-line viewer for documentation generated by `rustdoc`.
Initial project scaffolding This patch contains the initial project scaffolding, based on the files generated by cargo new.
2020-01-12 10:50:40 +00:00
## 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.
2020-07-16 19:01:29 +00:00
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.
2020-01-12 10:50:40 +00:00
## 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/
Reference in New Issue Copy Permalink