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

88 lines
2.7 KiB
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
Add installation and contributing information This patch extends the README.md file and adds the INSTALL.md and CONTRIBUTING.md files with more detailed information.
2020-07-19 23:34:56 +00:00
## Example Usage
```
$ cd rusty-man && cargo doc
$ rusty-man kuchiki::NodeRef
# Struct kuchiki::NodeRef
pub struct NodeRef(pub Rc<Node>);
A strong reference to a node.
$ rusty-man --source ~/.rustup/toolchains/stable-*/share/doc/html io::Error
# Struct std::io::Error
pub struct Error { /* fields omitted */ }
The error type for I/O operations of the `Read`, `Write`, `Seek`, and associated traits.
Errors mostly originate from the underlying OS, but custom instances of `Error` can be created with
crafted error messages and a particular value of `ErrorKind`.
Fix wrong command in example usage
2020-07-20 08:29:55 +00:00
$ rusty-man --source ~/.rustup/toolchains/stable-*/share/doc/rust/html u8
Add installation and contributing information This patch extends the README.md file and adds the INSTALL.md and CONTRIBUTING.md files with more detailed information.
2020-07-19 23:34:56 +00:00
Found mulitple matches for u8 – select one of:
[ 0 ] core::u8: The 8-bit unsigned integer type.
[ 1 ] std::u8: The 8-bit unsigned integer type.
> 1
# Primitive Type u8
The 8-bit unsigned integer type.
```
## Installation
To install rusty-man, clone this repository and use cargo to build the project.
See the [`INSTALL.md`](./INSTALL.md) file for more information.
rusty-man should run on all platforms supported by [`termion`][]. If you have
trouble running rusty-man on your platform or if you want to help porting
rusty-man to other platforms, please let me know.
## Contributing
Contributions to this project are very welcome! You can contribute by writing
Extend contributing guide This patch extends the CONTRIBUTING.md file with more information on possible tasks, the test suite and the code checks.
2020-07-20 08:23:28 +00:00
code or documentation or by testing. See the [`CONTRIBUTING.md`][] file for
more information.
Add installation and contributing information This patch extends the README.md file and adds the INSTALL.md and CONTRIBUTING.md files with more detailed information.
2020-07-19 23:34:56 +00:00
If you are looking for a good starting point, have a look at the [issues with
the label “good first issue”][issues] in rusty-man’s issue tracker.
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
Add installation and contributing information This patch extends the README.md file and adds the INSTALL.md and CONTRIBUTING.md files with more detailed information.
2020-07-19 23:34:56 +00:00
mail to the mailing list [~ireas/rusty-man-dev@lists.sr.ht][] ([public
Extend contributing guide This patch extends the CONTRIBUTING.md file with more information on possible tasks, the test suite and the code checks.
2020-07-20 08:23:28 +00:00
archive][]) or [contact me directly][]. You can also use the rusty-man [issue
tracker][] for bug reports or features requests.
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
## License
This project is licensed under the [MIT License][].
`rusty-man` complies with [version 3.0 of the REUSE specification][reuse].
Add installation and contributing information This patch extends the README.md file and adds the INSTALL.md and CONTRIBUTING.md files with more detailed information.
2020-07-19 23:34:56 +00:00
[`termion`]: https://lib.rs/termion
Extend contributing guide This patch extends the CONTRIBUTING.md file with more information on possible tasks, the test suite and the code checks.
2020-07-20 08:23:28 +00:00
[`CONTRIBUTING.md`]: ./CONTRIBUTING.md
Add installation and contributing information This patch extends the README.md file and adds the INSTALL.md and CONTRIBUTING.md files with more detailed information.
2020-07-19 23:34:56 +00:00
[issues]: https://todo.sr.ht/~ireas/rusty-man?search=label:%22good%20first%20issue%22%20status%3Aopen
[~ireas/rusty-man-dev@lists.sr.ht]: mailto:~ireas/rusty-man-dev@lists.sr.ht
Extend contributing guide This patch extends the CONTRIBUTING.md file with more information on possible tasks, the test suite and the code checks.
2020-07-20 08:23:28 +00:00
[contact me directly]: mailto:robin.krahl@ireas.org
Add installation and contributing information This patch extends the README.md file and adds the INSTALL.md and CONTRIBUTING.md files with more detailed information.
2020-07-19 23:34:56 +00:00
[public archive]: https://lists.sr.ht/~ireas/rusty-man-dev
[issue tracker]: https://todo.sr.ht/~ireas/rusty-man
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
[MIT license]: https://opensource.org/licenses/MIT
[reuse]: https://reuse.software/practices/3.0/
Reference in New Issue Copy Permalink