Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial oranda setup #5044

Merged
merged 2 commits into from
Jul 7, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ target/
/busybox/
/.vscode/
/.vs/
/public/
*~
.*.swp
.*.swo
Expand Down
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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">

Check failure on line 4 in README.md

View workflow job for this annotation

GitHub Actions / Style/spelling (ubuntu-latest, feat_os_unix)

ERROR: Unknown word (oranda) (file:'README.md', line:4)
<div align="center">

![uutils logo](docs/src/logo.svg)
Expand All @@ -19,18 +20,23 @@

---

</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">

Check failure on line 29 in README.md

View workflow job for this annotation

GitHub Actions / Style/spelling (ubuntu-latest, feat_os_unix)

ERROR: Unknown word (oranda) (file:'README.md', line:29)

To install it:

```shell
cargo install coreutils
~/.cargo/bin/coreutils
```

</div>

<!-- markdownlint-disable-next-line MD026 -->

## Goals
Expand All @@ -42,6 +48,8 @@
utils on Linux, Mac, Windows and other platforms. This ensures, for example,
that scripts can be easily transferred between platforms.

<div class="oranda-hide">

Check failure on line 51 in README.md

View workflow job for this annotation

GitHub Actions / Style/spelling (ubuntu-latest, feat_os_unix)

ERROR: Unknown word (oranda) (file:'README.md', line:51)

## Documentation

uutils has both user and developer documentation available:
Expand All @@ -52,6 +60,7 @@
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
Expand Down Expand Up @@ -301,6 +310,8 @@

![Evolution over time](https://github.com/uutils/coreutils-tracking/blob/main/gnu-results.png?raw=true)

</div> <!-- close oranda-hide div -->

Check failure on line 313 in README.md

View workflow job for this annotation

GitHub Actions / Style/spelling (ubuntu-latest, feat_os_unix)

ERROR: Unknown word (oranda) (file:'README.md', line:313)

## Contributing

To contribute to uutils, please see [CONTRIBUTING](CONTRIBUTING.md).
Expand Down
4 changes: 4 additions & 0 deletions docs/src/oranda.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.logo {
display: block;
height: 170px;
}
13 changes: 13 additions & 0 deletions oranda.json
Original file line number Diff line number Diff line change
@@ -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"]

Check failure on line 11 in oranda.json

View workflow job for this annotation

GitHub Actions / Style/spelling (ubuntu-latest, feat_os_unix)

ERROR: Unknown word (oranda) (file:'oranda.json', line:11)
}
}
Loading