From abe675e4ab73b37dbfcb62bb35b835f0f477f19c Mon Sep 17 00:00:00 2001 From: Sylvestre Ledru Date: Fri, 28 Jan 2022 20:57:21 +0100 Subject: [PATCH] update of the doc --- README.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index f80764b14..fcba6ff6f 100644 --- a/README.md +++ b/README.md @@ -4,21 +4,24 @@ This repository generates the user and dev documentations of https://github.com/ ## User documentation -Can be generated with +It is available on: +https://uutils.github.io/coreutils-docs/user/ + +Can be generated with: ``` cargo run --bin uudoc --all-features cd docs mdbook build ``` -It is available on: -https://uutils.github.io/coreutils-docs/user/ - -# Developer documentation: - -The code documentation is generated daily from the https://github.com/uutils/coreutils repository. +## Developer documentation: It is available on: -https://uutils.github.io/coreutils-docs/dev/ +https://uutils.github.io/coreutils-docs/dev/coreutils/ + +Can be generated with: +`` +cargo doc --no-deps --all-features --workspace +``` The pages are committed daily into the gh-pages branch.