up su Gitea

noctalia/plugins/catwalk/README.md

@@ -0,0 +1,34 @@
+# Catwalk Plugin for Noctalia
+
+A cute animated cat for your Noctalia bar that reacts to your system's CPU usage.
+
+## Features
+
+- **Animated Cat**: The cat walks/runs on your bar based on CPU usage
+- **CPU-Based Animation**:
+  - Below minimum threshold: Shows idle animation with "Zz" bubbles
+  - Above minimum threshold: Walks faster as CPU usage increases
+  - Speed scales continuously with CPU load
+- **Popup Panel**: Click the cat to open a larger animated version with CPU stats
+- **Theme Support**: Automatically switches between light/dark mode icons
+- **Configurable Settings**: Adjust the minimum CPU threshold for running animation
+
+## Installation
+
+This plugin is part of the `noctalia-plugins` repository.
+
+## Configuration
+
+Access the plugin settings in Noctalia to configure:
+
+- **Minimum CPU Threshold**: Set the CPU usage percentage (5-25%) above which the cat starts running. Below this, it stays idle with "Zz" animation.
+
+## Usage
+
+- The cat icon appears on your bar
+- It automatically animates based on your CPU usage
+- Click to open the CPU stats panel
+
+## Requirements
+
+- Noctalia 3.6.0 or later