From 2b6494475a7ab0bcaae8af4b6f640a0de3b0891e Mon Sep 17 00:00:00 2001 From: Sylvestre Ledru <sylvestre@debian.org> Date: Sat, 17 Feb 2024 22:52:12 +0100 Subject: [PATCH] improve the readme --- README.md | 31 ++++++++++++++++++++++++------- 1 file changed, 24 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 3ac410d..04b67d3 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,10 @@ +[](https://crates.io/crates/util-linux) +[](https://discord.gg/wQVJbvJ) +[](https://github.com/uutils/util-linux/blob/main/LICENSE) +[](https://deps.rs/repo/github/uutils/util-linux) + +[](https://codecov.io/gh/uutils/util-linux) + # util-linux This projects aims at doing the same as https://github.com/uutils/coreutils for util-linux. @@ -5,13 +12,6 @@ This projects aims at doing the same as https://github.com/uutils/coreutils for We are rewriting <a href="http://www.kernel.org/pub/linux/utils/util-linux/">these tools</a> in Rust as dropped-in replacements. - - -Currently, we have skeletons for: - -* /bin/mountpoint: Checks if a directory is a mountpoint. - - First, reimplement the most important tools from util-linux ## System Information - dmesg: Displays kernel messages. @@ -105,3 +105,20 @@ Note: Project: http://www.kernel.org/pub/linux/utils/util-linux/ + +## Installation + +Ensure you have Rust installed on your system. You can install Rust through [rustup](https://rustup.rs/). + +Clone the repository and build the project using Cargo: + +```bash +git clone https://github.com/uutils/util-linux.git +cd util-linux +cargo build --release +cargo run --release +``` + +## License + +util-linux is licensed under the MIT License - see the `LICENSE` file for details