From 357dd5fd8893520852e5781ebcdd6cc7e5e69f70 Mon Sep 17 00:00:00 2001 From: Terts Diepraam Date: Wed, 5 Jul 2023 16:00:16 +0200 Subject: [PATCH 1/2] initial oranda setup --- .gitignore | 1 + README.md | 11 +++++++++++ docs/src/oranda.css | 4 ++++ oranda.json | 13 +++++++++++++ 4 files changed, 29 insertions(+) create mode 100644 docs/src/oranda.css create mode 100644 oranda.json 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..76d30bf614e 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"] + } +} From 79b44597315a3046d736a44c155ab66537077578 Mon Sep 17 00:00:00 2001 From: Sylvestre Ledru Date: Sat, 8 Jul 2023 00:32:32 +0200 Subject: [PATCH 2/2] add oranda to the spell ignore --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 76d30bf614e..4929224d195 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ - +