Awesome
<br /> <div align="center"> <a href="https://github.com/iinsertNameHere/catnap"> <center><img width="170px" src="image/logo/catnap.svg"></center> </a> <h1 align="center"><code>Catnap🌿</code> Systemfetch</h1> <p align="center"> <a href="#-demo-images">View Demo</a> · <a href="#-documentation">Documentation</a> · <a href="#-contributing">Contributing</a> </p> <p align="center"> <a href="https://github.com/iinsertNameHere/catnap/actions/workflows/test-catnap.yml"> <img src="https://github.com/iinsertNameHere/catnap/actions/workflows/test-catnap.yml/badge.svg?branch=main" /> </p> </div> <br>🌿 What is Catnap
I created Catnap🌿
(originally known as Catnip
) as a playful, simple system-information concatenation tool using nim👑
. It is quite customizable and has possibilities to alter the names and colors of the statistics. In the future, I also intend to add more distribution logos. Feel free to contribute to the project at any time.
⏱️ Execution Time
*Around 0.006 seconds on my laptop
📊 Displayed Statistics
<details> <summary style="font-size: 18px; font-weight: 600;">View Statistics</summary> <ul> <li>username</li> <li>hostname</li> <li>uptime</li> <li>os</li> <li>kernel</li> <li>desktop</li> <li>shell</li> <li>terminal</li> <li>memory</li> <li>battery</li> <li>disk space</li> <li>cpu info</li> <li>packages</li> <li>weather</li> <li>colors</li> </ul> </details>❤️ Shoutout to:
- NimParsers/parsetoml for the toml parsing
- ssleert/Nitch for the inspiration
- All contributors
Feel free to submit issues if you have any improvement ideas! ❤
<br>📷 Demo Images
<details> <summary style="font-size: 18px; font-weight: 600;">Demo Images ✨</summary><i>Default:</i> <br> <img src="image/demo1.png"> <br> <i>FigletLogos (<a href="https://github.com/ssleert/nitch">Nitch</a> mode):</i> <br> <img src="image/demo2.png"> <br> <i>Image Mode:</i> <br> <img src="image/demo3.png"> <br> <i>Distro Showcase:</i> <br> <img src="image/distros.png">
<br> </details> <br>📒 Documentation
You can read the full documentation here <br> It covers installation, usage and configuration!
<br>If you think something is missing, feel free to open a Issue in the catnap-docs repository.
🧪 Testing
To test catnap, run the following command in the catnap repo:
$ cd tests/
$ ./commandline_args.sh
<br>
🐛 Bugs
If you've found a bug, please follow the steps below:
- Make sure you're on the latest commit, as bugs that are in your current version might've been fixed in later commits.
- Run
catnap -v
and copy the output into your clipboard. - Create an issue and remember to click on the bug report template!
- Fill in the details and submit the report.
🔨 Contributing
For more info on how to contribute and how to add a new distro, see CONTRIBUTING.md.
<br>