From 0f76ca0ffa29ca8a5d43a23fdef987c1c4b67f7a Mon Sep 17 00:00:00 2001 From: Terts Diepraam Date: Sat, 29 Jan 2022 01:19:15 +0100 Subject: [PATCH] README: add links to documentation --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f9ee6a867..ff02c979d 100644 --- a/README.md +++ b/README.md @@ -29,13 +29,20 @@ have other issues. Rust provides a good, platform-agnostic way of writing systems utilities that are easy to compile anywhere, and this is as good a way as any to try and learn it. +## Documentation +uutils has both user and developer documentation available: + +- [User Manual](https://uutils.github.io/coreutils-docs/user/) +- [Developer Documentation](https://uutils.github.io/coreutils-docs/dev/) + +Both can also be generated locally, the instructions for that can be found in the +[coreutils docs](https://github.com/uutils/coreutils-docs) repository. + ## Requirements * Rust (`cargo`, `rustc`) -* GNU Make (required to build documentation) -* [Sphinx](http://www.sphinx-doc.org/) (for documentation) -* gzip (for installing documentation) +* GNU Make (optional) ### Rust Version