diff --git a/.gitignore b/.gitignore index 77e8f717e5e..ed4e54ec5bc 100644 --- a/.gitignore +++ b/.gitignore @@ -5,6 +5,7 @@ target/ /busybox/ /.vscode/ /.vs/ +/public/ *~ .*.swp .*.swo diff --git a/README.md b/README.md index 5a9f968ae6a..4929224d195 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ - + +
![uutils logo](docs/src/logo.svg) @@ -19,11 +20,14 @@ --- +
uutils coreutils is a cross-platform reimplementation of the GNU coreutils in [Rust](http://www.rust-lang.org). While all programs have been implemented, some options might be missing or different behavior might be experienced. +
+ To install it: ```shell @@ -31,6 +35,8 @@ cargo install coreutils ~/.cargo/bin/coreutils ``` +
+ ## Goals @@ -42,6 +48,8 @@ uutils aims to work on as many platforms as possible, to be able to use the same utils on Linux, Mac, Windows and other platforms. This ensures, for example, that scripts can be easily transferred between platforms. +
+ ## Documentation uutils has both user and developer documentation available: @@ -52,6 +60,7 @@ uutils has both user and developer documentation available: Both can also be generated locally, the instructions for that can be found in the [coreutils docs](https://github.com/uutils/uutils.github.io) repository. + ## Requirements @@ -301,6 +310,8 @@ See for the main meta bugs ![Evolution over time](https://github.com/uutils/coreutils-tracking/blob/main/gnu-results.png?raw=true) +
+ ## Contributing To contribute to uutils, please see [CONTRIBUTING](CONTRIBUTING.md). diff --git a/docs/src/oranda.css b/docs/src/oranda.css new file mode 100644 index 00000000000..5581cc0c57f --- /dev/null +++ b/docs/src/oranda.css @@ -0,0 +1,4 @@ +.logo { + display: block; + height: 170px; +} diff --git a/oranda.json b/oranda.json new file mode 100644 index 00000000000..b0a93c19aff --- /dev/null +++ b/oranda.json @@ -0,0 +1,13 @@ +{ + "project": { + "name": "uutils coreutils" + }, + "components": { + "changelog": true + }, + "styles": { + "theme": "light", + "logo": "docs/src/logo.svg", + "additional_css": ["docs/src/oranda.css"] + } +}