uutils.github.io/README.md

# coreutils documentations

This repository generates the user and dev documentations of https://github.com/uutils/coreutils

## User documentation

It is available on:
https://uutils.github.io/user/

Can be generated with:
```
cargo run --bin uudoc --all-features
cd docs
mdbook build
```

## Developer documentation:

It is available on:
https://uutils.github.io/dev/coreutils/

Can be generated with:
```
cargo doc --no-deps --all-features --workspace
```

The pages are committed daily into the gh-pages branch.

## Build timing

Generated by cargo, the build timings can be seen on:
https://uutils.github.io/cargo-timings/cargo-timing.html