RGBCube/uutils-coreutils
1
Fork 0
mirror of https://github.com/RGBCube/uutils-coreutils synced 2025-08-01 05:27:45 +00:00
Code Issues Activity

README: add links to documentation

Browse source
This commit is contained in:
Terts Diepraam 2022-01-29 01:19:15 +01:00
parent 9dbff22101
commit 0f76ca0ffa
1 changed files with 10 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -29,13 +29,20 @@ have other issues.
Rust provides a good, platform-agnostic way of writing systems utilities that are easy 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. 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.
<!-- ANCHOR: installation (this mark is needed for mdbook) --> <!-- ANCHOR: installation (this mark is needed for mdbook) -->
## Requirements ## Requirements
* Rust (`cargo`, `rustc`) * Rust (`cargo`, `rustc`)
* GNU Make (required to build documentation) * GNU Make (optional)
* [Sphinx](http://www.sphinx-doc.org/) (for documentation)
* gzip (for installing documentation)
### Rust Version ### Rust Version