From 4dac60165b450810b341fc8efb06e8247d4697fe Mon Sep 17 00:00:00 2001 From: yuki Date: Wed, 8 May 2024 18:18:27 +0800 Subject: [PATCH] Updated README.md --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4838976..09c0924 100644 --- a/README.md +++ b/README.md @@ -79,6 +79,8 @@ I created `Catnip🌿` as a playful, simple system-information **concatenation** ## 🪡 Installation/Build +>Arch Linux users can install Catnip through the [AUR](https://aur.archlinux.org/packages/catnip-git) (git package) + **1.** Install `nim👑` and all dependencies >#### Dependencies: @@ -221,7 +223,7 @@ sep_color = "SEPARATOR" colors = {icon = ">", name = "colors", color = "!DT!", symbol = "#"} ``` -*You can add more disks to you stats by just creating a new `disk_[index]` stat. Don't adding the `_[index]` suffix, uses index 0.* +*You can add more disks to you stats by just creating a new `disk_[index]` stat. If no`_[index]` is added to the end of `disk`, Catnip will use index 0. (aka the first disk)* ```toml ############################################## ## FetchInfo stats Config ## @@ -358,13 +360,16 @@ art = [ ] ``` -
-
+## 🧪 Testing +To test the functionality of catnip, run this after compiling catnip: +```bash +$ ./tests/test.sh +``` -# Contributing +## Contributing More info in [CONTRIBUTING.md](CONTRIBUTING.md) -# Thanks to all contributors ❤ +## Thanks to all contributors ❤