32 lines
1.1 KiB
Markdown
32 lines
1.1 KiB
Markdown
# bunbun
|
|
> A simple and adorable sysinfo utility written in Rust.
|
|
|
|
<p align="center">
|
|
<img src="./demo/demo.gif" alt="bunbun demo" width="400"/>
|
|
</p>
|
|
|
|
## Installation
|
|
To build `bunbun`, you'll need [Rust](https://rust-lang.org) installed:
|
|
```bash
|
|
$ git clone https://git.devraza.giize.com/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.
|
|
|
|
### NixOS
|
|
`bunbun` is now packaged on NixOS/nixpkgs, maintained by [GaetanLepage](https://github.com/GaetanLepage)! If you have Nix installed, you can try it with:
|
|
```bash
|
|
nix-shell -p bunbun
|
|
```
|
|
To install it on NixOS or home-manager, add it to `environment.systemPackages` or `home.packages` respectively.
|
|
|
|
## 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).
|