bunbun/README.md

25 lines
804 B
Markdown
Raw Normal View History

2024-03-23 21:57:55 +00:00
# bunbun
2024-03-24 13:16:20 +00:00
> A simple and adorable sysinfo utility written in Rust.
2024-03-23 21:57:55 +00:00
2024-03-24 13:30:26 +00:00
<p align="center">
2024-03-24 13:32:22 +00:00
<img src="./demo/demo.gif" alt="bunbun demo" width="400"/>
2024-03-24 13:30:26 +00:00
</p>
2024-03-24 13:16:20 +00:00
## Installation
To build `bunbun`, you'll need [Rust](https://rust-lang.org) installed:
```bash
2024-05-05 23:45:36 +01:00
$ git clone https://git.devraza.giize.com/devraza/bunbun
2024-03-24 13:16:20 +00:00
$ 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).