initial oranda setup

This commit is contained in:
Terts Diepraam 2023-07-05 16:00:16 +02:00
parent 844eefe961
commit 357dd5fd88
4 changed files with 29 additions and 0 deletions

1
.gitignore vendored
View file

@ -5,6 +5,7 @@ target/
/busybox/
/.vscode/
/.vs/
/public/
*~
.*.swp
.*.swo

View file

@ -1,6 +1,7 @@
<!-- markdownlint-disable MD033 MD041 MD002 -->
<!-- markdownlint-disable commands-show-output no-duplicate-heading -->
<!-- spell-checker:ignore markdownlint ; (options) DESTDIR UTILNAME manpages reimplementation -->
<div class="oranda-hide">
<div align="center">
![uutils logo](docs/src/logo.svg)
@ -19,11 +20,14 @@
---
</div>
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.
<div class="oranda-hide">
To install it:
```shell
@ -31,6 +35,8 @@ cargo install coreutils
~/.cargo/bin/coreutils
```
</div>
<!-- markdownlint-disable-next-line MD026 -->
## 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.
<div class="oranda-hide">
## 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.
<!-- ANCHOR: build (this mark is needed for mdbook) -->
## Requirements
@ -301,6 +310,8 @@ See <https://github.com/uutils/coreutils/issues/3336> for the main meta bugs
![Evolution over time](https://github.com/uutils/coreutils-tracking/blob/main/gnu-results.png?raw=true)
</div> <!-- close oranda-hide div -->
## Contributing
To contribute to uutils, please see [CONTRIBUTING](CONTRIBUTING.md).

4
docs/src/oranda.css Normal file
View file

@ -0,0 +1,4 @@
.logo {
display: block;
height: 170px;
}

13
oranda.json Normal file
View file

@ -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"]
}
}