Skip to content

Commit

Permalink
Merge pull request #11 from yuki-was-taken/main
Browse files Browse the repository at this point in the history
Added note on stat execution stat as well as updated dependancy list.
  • Loading branch information
iinsertNameHere authored Jun 1, 2024
2 parents ec72f5f + f9de271 commit 002eef7
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/src/Configuration/Stats.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**File:** `config.toml`

> **NOTE:** The execution time of Catnip will increase when enabling the package manager stat.
> **NOTE:** The execution time of Catnip will increase when enabling the package manager, weather and GPU stats. Catnip **cannot** in any way decrease the time for the weather and package manager stats. This is due to the fact that the package manager stat is dependent on the speed of your distro's package manager, and the weather stat is dependent on your internet speed as well as the response time of the weather info website, [wttr.in](https://github.com/chubin/wttr.in).
## Icons
You can change the icon of any `stat` inside of the `[stats]` section.
Expand Down
7 changes: 5 additions & 2 deletions docs/src/Setup/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,13 @@ $ yay -S catnip-git
**1.** Install all dependencies:
- **Required:**
- Build dependencies: `nim, gzip`
- Runtime dependencies: `pcre, usbutils`
- Runtime dependencies: `pcre`, `usbutils`

- **Optional:**
- `figlet`: For figlet logos mode.
- `viu`: For image mode.
- `curl`: For weather stat.
- `pciutils`: For GPU stat.

**2.** Clone the official catnip repository:
```shell
Expand All @@ -33,4 +36,4 @@ nim install
This will automatically build catnip and install it inside of your `/usr/local/bin` folder.

> **IMPORTANT**:
> For the default icons to work, make sure you set a [NerdFont](https://www.nerdfonts.com/) as you terminal font.
> For the default icons to work, make sure you set a [NerdFont](https://www.nerdfonts.com/) as you terminal font. In addition, for the weather module to work, you will need a font that supports emojis.

0 comments on commit 002eef7

Please sign in to comment.