docs: improve README.md

This commit is contained in:
Muhammad Nauman Raza 2024-03-24 13:16:20 +00:00
parent 9b0a26aff2
commit 84f9b7a72c
Signed by: devraza
GPG key ID: 91EAD6081011574B

View file

@ -1,3 +1,20 @@
# bunbun
> A simple and adorable sysinfo utility written in Rust.
A simple and adorable sysinfo utility written in Rust.
## Installation
To build `bunbun`, you'll need [Rust](https://rust-lang.org) installed:
```bash
$ git clone https://git.devraza.duckdns.org/devraza/bunbun
$ cd bunbun
$ cargo build --release # `--release` adds a few optimisations
```
> **Using the flake!**
> This repository contains a `flake.nix` - if you have Nix installed, you can run `nix run github:devraza/bunbun` to compile and run the program.
## Inspiration
- [Rosettea/bunnyfetch](https://github.com/Rosettea/bunnyfetch)
- [elenapan's `bunnyfetch` script](https://github.com/elenapan/dotfiles/blob/master/bin/bunnyfetch)
## License
This project is covered by the [MIT License](./LICENSE).