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.
This commit is contained in:
Robin Krahl
parent
e1ef283159
commit
1128919f1f
34
CONTRIBUTING.md
Normal file
34
CONTRIBUTING.md
Normal file
@ -0,0 +1,34 @@
|
||||
<!---
|
||||
SPDX-FileCopyrightText: 2020 Robin Krahl <robin.krahl@ireas.org>
|
||||
SPDX-License-Identifier: MIT
|
||||
-->
|
||||
|
||||
# Contributing to rusty-man
|
||||
|
||||
## Project infrastructure
|
||||
|
||||
rusty-man is hosted on [sourcehut.org](https://sourcehut.org) and uses these
|
||||
services:
|
||||
- [git.sr.ht/~ireas/rusty-man][git]: Git repository
|
||||
- [todo.sr.ht/~ireas/rusty-man][todo]: issue tracker
|
||||
- [lists.sr.ht/~ireas/rusty-man-dev][ml]: mailing list
|
||||
- [builds.sr.ht/~ireas/rusty-man][ci]: build server for continuous integration
|
||||
|
||||
## Submitting patches
|
||||
|
||||
There are two ways to submit patches for rusty-man:
|
||||
|
||||
1. Use `git send-email` to send your patches to the mailing list
|
||||
[~ireas/rusty-man-dev@lists.sr.ht][list]. If you are not familiar with the
|
||||
`git send-email` workflow, have a look at [this step-by-step
|
||||
guide](https://git-send-email.io) and feel free to [contact
|
||||
me](mailto:robin.krahl@ireas.org) for more information.
|
||||
2. Push your changes to a public repository, for example hosted on your own Git
|
||||
server, sourcehut.org, Gitlab or GitHub, and use `git request-pull` to send
|
||||
a pull request to the mailing list [~ireas/rusty-man-dev@lists.sr.ht][list].
|
||||
|
||||
[git]: https://git.sr.ht/~ireas/rusty-man
|
||||
[todo]: https://todo.sr.ht/~ireas/rusty-man
|
||||
[ml]: https://lists.sr.ht/~ireas/rusty-man-dev
|
||||
[ci]: https://builds.sr.ht/~ireas/rusty-man
|
||||
[list]: mailto:~ireas/rusty-man-dev@lists.sr.ht
|
||||
28
INSTALL.md
Normal file
28
INSTALL.md
Normal file
@ -0,0 +1,28 @@
|
||||
<!---
|
||||
SPDX-FileCopyrightText: 2020 Robin Krahl <robin.krahl@ireas.org>
|
||||
SPDX-License-Identifier: MIT
|
||||
-->
|
||||
|
||||
# Installing rusty-man
|
||||
|
||||
## Installing from source
|
||||
|
||||
To install rusty-man from source, you need Rust 1.40 or later.
|
||||
|
||||
1. Clone the rusty-man Git repository:
|
||||
```
|
||||
$ git clone https://git.sr.ht/~ireas/rusty-man && cd rusty-man
|
||||
```
|
||||
2. Optional: Verify the signature of the latest commit:
|
||||
```
|
||||
$ curl -s "https://pgp.ireas.org/0x6D533958F070C57C.txt" | gpg --import
|
||||
$ gpg verify-commit HEAD
|
||||
```
|
||||
3. Compile rusty-man:
|
||||
```
|
||||
$ cargo build --release
|
||||
```
|
||||
4. Optional: Install the rusty-man binary:
|
||||
```
|
||||
$ sudo cp ./target/release/rusty-man /usr/local/bin/rusty-man
|
||||
```
|
||||
62
README.md
62
README.md
@ -7,6 +7,58 @@ SPDX-License-Identifier: MIT
|
||||
|
||||
A command-line viewer for documentation generated by `rustdoc`.
|
||||
|
||||
## 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`.
|
||||
|
||||
$ rusty-man --source ~/.rustup/toolchains/stable-*/share/doc/html u8
|
||||
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
|
||||
code or documentation or by testing. See the
|
||||
[`CONTRIBUTING.md`](./CONTRIBUTING.md) file for more information.
|
||||
|
||||
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.
|
||||
|
||||
## Minimum Supported Rust Version
|
||||
|
||||
This crate supports Rust 1.40 or later.
|
||||
@ -14,7 +66,9 @@ 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][].
|
||||
mail to the mailing list [~ireas/rusty-man-dev@lists.sr.ht][] ([public
|
||||
archive][]). You can also use the rusty-man [issue tracker][] for bug reports
|
||||
or features requests.
|
||||
|
||||
## License
|
||||
|
||||
@ -22,6 +76,10 @@ 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
|
||||
[`termion`]: https://lib.rs/termion
|
||||
[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
|
||||
[public archive]: https://lists.sr.ht/~ireas/rusty-man-dev
|
||||
[issue tracker]: https://todo.sr.ht/~ireas/rusty-man
|
||||
[MIT license]: https://opensource.org/licenses/MIT
|
||||
[reuse]: https://reuse.software/practices/3.0/
|
||||
|
||||
Loading…
Reference in New Issue
Block a user