mirror of
https://github.com/uutils/awk.git
synced 2026-06-10 16:15:04 -07:00
chore(README.md): prettify
This commit is contained in:
@@ -1,6 +1,47 @@
|
||||
<div align="center">
|
||||
|
||||

|
||||
|
||||
# uutils AWK
|
||||
|
||||
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.
|
||||
[](https://discord.gg/wQVJbvJ)
|
||||
[](https://github.com/uutils/awk/blob/main/LICENSE-MIT)
|
||||
[](https://github.com/uutils/awk/blob/main/LICENSE-APACHE)
|
||||
[](https://deps.rs/repo/github/uutils/awk)
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
uutils AWK is a WIP, cross-platform reimplementation of GNU AWK (a.k.a. `gawk`) in
|
||||
[Rust](http://www.rust-lang.org).
|
||||
|
||||
## Goals
|
||||
|
||||
uutils AWK aims to be a drop-in replacement for `gawk`. Differences with GNU
|
||||
are treated as bugs.
|
||||
|
||||
Our key objectives include:
|
||||
- Matching GNU's output (stdout and error code) exactly
|
||||
- Better error messages
|
||||
- Best-in-class memory safety
|
||||
- Improved performance
|
||||
- Providing comprehensive internationalization support (UTF-8, etc.)
|
||||
- Extensions when relevant
|
||||
|
||||
uutils AWK aims to work on as many platforms as possible, to be able to use the same
|
||||
utils on Linux, macOS, *BSD, Windows, WASI and other platforms. This ensures, for example,
|
||||
that scripts can be easily transferred between platforms.
|
||||
|
||||
## Requirements
|
||||
|
||||
- Rust (`cargo`, `rustc`)
|
||||
|
||||
### Rust Version
|
||||
|
||||
uutils AWK follows Rust's release channels and is tested against stable, beta and
|
||||
nightly. The minimum supported Rust version at the moment is the previous stable
|
||||
version, that is, 1.95.0 at the time of writing.
|
||||
|
||||
## State of the Repo
|
||||
|
||||
@@ -8,8 +49,10 @@ Check out https://github.com/uutils/awk/issues/16.
|
||||
|
||||
## Contributing
|
||||
|
||||
See [this](https://github.com/uutils/coreutils/blob/main/CONTRIBUTING.md).
|
||||
To contribute to uutils AWK, please see [CONTRIBUTING](https://github.com/uutils/coreutils/blob/main/CONTRIBUTING.md).
|
||||
|
||||
## License
|
||||
|
||||
This is licensed under either the MIT License or the Apache License v2.0. See the `LICENSE-MIT` and `LICENSE-APACHE` files for details.
|
||||
uutils AWK is licensed under either the MIT License or the Apache v2.0 License - see the `LICENSE-MIT`, `LICENSE-APACHE` files for details.
|
||||
|
||||
GNU AWK is licensed under the GPL 3.0 or later.
|
||||
|
||||
Reference in New Issue
Block a user