Skip to content

Commit ef34832

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

1 file changed

Lines changed: 46 additions & 3 deletions

File tree

README.md

Lines changed: 46 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,58 @@
1+
<div align="center">
2+
3+
![uutils logo](https://raw.githubusercontent.com/uutils/coreutils/refs/heads/main/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+
[![Discord](https://img.shields.io/badge/discord-join-7289DA.svg?logo=discord&longCache=true&style=flat)](https://discord.gg/wQVJbvJ)
8+
[![License](http://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/uutils/awk/blob/main/LICENSE-MIT)
9+
[![License](https://img.shields.io/badge/license-APACHE%202.0-orange.svg)](https://github.com/uutils/awk/blob/main/LICENSE-APACHE)
10+
[![dependency status](https://deps.rs/repo/github/uutils/awk/status.svg)](https://deps.rs/repo/github/uutils/awk)
11+
12+
</div>
13+
14+
---
15+
16+
uutils AWK is a WIP, cross-platform reimplementation of GNU AWK (a.k.a. `gawk`) in
17+
[Rust](http://www.rust-lang.org).
18+
19+
## Goals
20+
21+
uutils AWK aims to be a drop-in replacement for `gawk`. Differences with GNU
22+
are treated as bugs.
23+
24+
Our key objectives include:
25+
- Matching GNU's output (stdout and error code) exactly
26+
- Better error messages
27+
- Best-in-class memory safety
28+
- Improved performance
29+
- Providing comprehensive internationalization support (UTF-8, etc.)
30+
- Extensions when relevant
31+
32+
uutils AWK aims to work on as many platforms as possible, to be able to use the same
33+
utils on Linux, macOS, *BSD, Windows, WASI and other platforms. This ensures, for example,
34+
that scripts can be easily transferred between platforms.
35+
36+
## Requirements
37+
38+
- Rust (`cargo`, `rustc`)
39+
40+
### Rust Version
41+
42+
uutils AWK follows Rust's release channels and is tested against stable, beta and
43+
nightly. The minimum supported Rust version at the moment is the previous stable
44+
version, that is, 1.95.0 at the time of writing.
445

546
## State of the Repo
647

748
Check out https://github.com/uutils/awk/issues/16.
849

950
## Contributing
1051

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

1354
## License
1455

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.
56+
uutils AWK is licensed under either the MIT License or the Apache v2.0 License - see the `LICENSE-MIT`, `LICENSE-APACHE` files for details.
57+
58+
GNU AWK is licensed under the GPL 3.0 or later.

0 commit comments

Comments
 (0)