Skip to content

Commit ec55539

Browse files
committed
chore(README.md): prettify
1 parent 4bfce36 commit ec55539

1 file changed

Lines changed: 48 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 48 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,60 @@
1+
<div align="center">
2+
3+
![uutils logo](docs/src/logo.svg)
4+
15
# uutils AWK
26

3-
This is a human, WIP, and clean implementation of an AWK interpreter, written in Rust and compatible with GNU's AWK (`gawk`) bug-for-bug. Expected to be production-ready before Ubuntu 26.10. Made with love.
7+
[![Crates.io](https://img.shields.io/crates/v/coreutils.svg)](https://crates.io/crates/coreutils)
8+
[![Discord](https://img.shields.io/badge/discord-join-7289DA.svg?logo=discord&longCache=true&style=flat)](https://discord.gg/wQVJbvJ)
9+
[![License](http://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/uutils/coreutils/blob/main/LICENSE)
10+
[![dependency status](https://deps.rs/repo/github/uutils/coreutils/status.svg)](https://deps.rs/repo/github/uutils/coreutils)
11+
12+
[![CodeCov](https://codecov.io/gh/uutils/coreutils/branch/main/graph/badge.svg)](https://codecov.io/gh/uutils/coreutils)
13+
[![Weblate](https://hosted.weblate.org/widget/rust-coreutils/svg-badge.svg)](https://hosted.weblate.org/projects/rust-coreutils/)
14+
15+
</div>
16+
17+
---
18+
19+
uutils AWK is a WIP, cross-platform reimplementation of the GNU AWK (a.k.a. `gawk`) in
20+
[Rust](http://www.rust-lang.org).
21+
22+
## Goals
23+
24+
uutils AWK aims to be a drop-in replacement for `gawk`. Differences with GNU
25+
are treated as bugs.
26+
27+
Our key objectives include:
28+
- Matching GNU's output (stdout and error code) exactly
29+
- Better error messages
30+
- Providing comprehensive internationalization support (UTF-8)
31+
- Improved performances
32+
- Extensions when relevant
33+
34+
uutils aims to work on as many platforms as possible, to be able to use the same
35+
utils on Linux, macOS, *BSD, Windows, WASI and other platforms. This ensures, for example,
36+
that scripts can be easily transferred between platforms.
37+
38+
## Requirements
39+
40+
- Rust (`cargo`, `rustc`)
41+
42+
### Rust Version
43+
44+
uutils AWK follows Rust's release channels and is tested against stable, beta and
45+
nightly. The minimum supported Rust version at the moment is the previous stable
46+
version, that is, 1.95.0 at the time of writing.
447

548
## State of the Repo
649

750
Check out https://github.com/uutils/awk/issues/16.
851

952
## Contributing
1053

11-
See [this](https://github.com/uutils/coreutils/blob/main/CONTRIBUTING.md).
54+
To contribute to uutils AWK, please see [CONTRIBUTING](https://github.com/uutils/coreutils/blob/main/CONTRIBUTING.md).
1255

1356
## License
1457

15-
This is licensed under either the MIT License or the Apache License v2.0. See the `LICENSE-MIT` and `LICENSE-APACHE` files for details.
58+
uutils AWK is licensed under either the MIT License or the Apache v2.0 License - see the `LICENSE-MIT`, `LICENSE-APACHE` files for details.
59+
60+
GNU AWK is licensed under the GPL 3.0 or later.

0 commit comments

Comments
 (0)