diff --git a/README.md b/README.md index 8b32b6d..1bb37b8 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,43 @@ -# procps +[![Crates.io](https://img.shields.io/crates/v/bsdutils.svg)](https://crates.io/crates/bsdutils) +[![Discord](https://img.shields.io/badge/discord-join-7289DA.svg?logo=discord&longCache=true&style=flat)](https://discord.gg/wQVJbvJ) +[![License](http://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/uutils/bsdutils/blob/main/LICENSE) +[![dependency status](https://deps.rs/repo/github/uutils/bsdutils/status.svg)](https://deps.rs/repo/github/uutils/bsdutils) + +[![CodeCov](https://codecov.io/gh/uutils/bsdutils/branch/master/graph/badge.svg)](https://codecov.io/gh/uutils/bsdutils) + +# bsdutils Rust reimplemtation of the bsdutils project Provides command line tools: -- `/usr/bin/logger`: This command is used to add logs to the system log files. It provides a shell command interface to the syslog system log module. - +Started: - `/usr/bin/renice`: This command is used to change the priority of running processes. It can be used to increase or decrease the nice value of a process. +TODO: +- `/usr/bin/logger`: This command is used to add logs to the system log files. It provides a shell command interface to the syslog system log module. + - `/usr/bin/script`: This command is used to record a terminal session. The script makes a typescript of everything printed on your terminal. - `/usr/bin/scriptlive`: This command is not standard, and may not be installed on all systems. If it exists, it's likely a variant of the `script` command that includes real-time features. - `/usr/bin/scriptreplay`: This command is used to replay a terminal session that was recorded using the `script` command. -- `/usr/bin/wall`: This command is used to broadcast a message to all users logged into a system. The message can be typed directly into the terminal or read from a file. \ No newline at end of file +- `/usr/bin/wall`: This command is used to broadcast a message to all users logged into a system. The message can be typed directly into the terminal or read from a file. + +## 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/bsdutils.git +cd bsdutils +cargo build --release +cargo run --release +``` + + +## License + +bsdutils is licensed under the MIT License - see the `LICENSE` file for details