Skip to content

Commit

Permalink
Merge pull request #71 from yu-kiat/main
Browse files Browse the repository at this point in the history
Updated README.md
  • Loading branch information
iinsertNameHere authored May 8, 2024
2 parents bb15b64 + 4dac601 commit e49d298
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,8 @@ I created `Catnip🌿` as a playful, simple system-information **concatenation**
</details>

## 🪡 Installation/Build
>Arch Linux users can install Catnip through the [AUR](https://aur.archlinux.org/packages/catnip-git) (git package)
**1.** Install <a href="https://nim-lang.org/install.html">`nim👑`</a> and all dependencies

>#### Dependencies:
Expand Down Expand Up @@ -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 ##
Expand Down Expand Up @@ -358,13 +360,16 @@ art = [
]
```

<br>
<br>
## 🧪 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 ❤

<a href = "https://github.com/iinsertNameHere/catnip/graphs/contributors">
<img src = "https://contrib.rocks/image?repo=iinsertNameHere/catnip">
Expand Down

0 comments on commit e49d298

Please sign in to comment.