rusty-man is hosted on sourcehut.org and uses these services:
You can help by proofreading and extending the documentation in the readme file and the contributing and installation guides. Also, rusty-man is lacking a man page and a usage guide – contributions are welcome!
If you are using rusty-man and are encountering any issues, please let me know. I’m especially interested in reports from other operating systems than Linux. You can also help by writing unit tests, especially for the HTML documentation parser.
Please submit patches by sending a mail to the mailing list ~email@example.com. There are three ways to do that:
git send-emailto send your patches. If you are not familiar with the
git send-emailworkflow, have a look at this step-by-step guide or contact me for more information.
git request-pullto send a pull request to the mailing list.
cargo test --bins, but make sure to generate rusty-man’s documentation with
cargo docbefore running the tests!
instafor snapshot testing. The test suite uses the documentation stored in the
tests/htmldirectory (generated by different versions of
rustdoc). If you set the
RUSTY_MAN_GENERATEenvironment variable, it will also use
cargo docto generate the documentation.
cargo fmtfor code formatting.