mirror of
https://github.com/uutils/coreutils
synced 2024-10-04 14:59:20 +00:00
README: add links to documentation
This commit is contained in:
parent
9dbff22101
commit
0f76ca0ffa
13
README.md
13
README.md
|
@ -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
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue