1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167 | diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c282b63
--- /dev/null
+++ b/README.md
@@ -0,0 +1,161 @@
+# Pino: Pixel Notification
+
+Pino is a fully customizable notification tool that lets you display notifications with various options. It supports integration with Pywal to automatically match the notification theme to your wallpaper and includes customizable options for screen placement, fonts, and colors. You can also reach out to the developer via Discord: **pi66**.
+
+---
+
+## Shortcuts
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Example: Low Battery Alert](#example-low-battery-alert)
+- [System Startup](#system-startup)
+- [Configuration](#configuration)
+- [Dependencies](#dependencies)
+- [Hardware Usage](#hardware-usage)
+- [Contributing](#contributing)
+- [License](#license)
+
+---
+
+## Features
+- **Customizable Notifications**: Set titles, messages, opacity, delay, sounds, and configuration files.
+- **Dynamic Theming with Pywal**: Automatically matches the notification theme to your wallpaper.
+- **Configurable Settings**: Adjust themes, screen placement, fonts, and more via JSON config files.
+- **Script Integration**: Automate notifications using scripts in any language.
+- **Pluggable Architecture**: Add custom scripts to the `~/.config/pino/plugs` directory.
+- **System Start Scripts**: Use `pino_start` to initialize scripts at system startup.
+
+---
+
+## Installation
+
+Run the `install.py` script to set up the application:
+
+```bash
+python install.py
+```
+
+---
+
+## Dependencies
+
+Pino requires the following dependencies:
+- Python 3.6 or later
+- Libraries listed in `requirements.txt` (installed via `pip install -r requirements.txt`)
+- System tools:
+ - `xclip` or `xsel` for clipboard integration
+ - `notify-send` for notification handling on Linux
+- Optional: Pywal for dynamic theming
+
+---
+
+## Usage
+
+Pino supports a variety of command-line options:
+
+```bash
+usage: pino [-h] [--title ] [--message ] [--opacity ] [--delay ] [--sound ] [--config ]
+
+Options:
+ -h, --help Show this help message and exit
+ --title Set the notification title content
+ --message Set the notification message content
+ --opacity Set the opacity level for the window (range: 0 to 100)
+ --delay Set the delay before the program closes (in seconds)
+ --sound Set a custom sound file for notifications
+ --config Set a custom configuration file
+```
+
+### Example: Low Battery Alert
+You can create a script to notify about low battery status. Example in C:
+
+```c
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <unistd.h>
+
+void pino(const char *title, const char *message) {
+ char command[256];
+ snprintf(command, sizeof(command), "pino --title \"%s\" --message \"%s\"", title, message);
+ system(command);
+}
+
+int main() {
+ pino("Low Battery", "Please plug in your charger!");
+ return 0;
+}
+```
+
+Compile and save the script to `~/.config/pino/plugs/`.
+
+### System Startup
+Add `pino_start` to your system startup to enable all scripts automatically.
+
+---
+
+## Configuration
+
+The app uses a JSON configuration file located at `~/.config/pino/config.json`. Example:
+
+```json
+{
+ "screen": {
+ "monitor": 0,
+ "vertical": "right",
+ "horizontal": "top",
+ "x": 20,
+ "y": 20,
+ "width": 300,
+ "height": 100,
+ "opacity": 100,
+ "show": 3
+ },
+ "frame": {
+ "fg_color": "#1a1e24",
+ "font_family": "Fira Code",
+ "border": {
+ "width": 3,
+ "color": "#566D8d",
+ "border_radius": 10
+ }
+ },
+ "title": {
+ "color": "#c5c6c8",
+ "font_size": 19,
+ "x": 10,
+ "y": 10,
+ "weigth": "bold",
+ "wrap_length": "auto"
+ },
+ "message": {
+ "color": "#626977",
+ "font_size": 15,
+ "x": 15,
+ "y": 45,
+ "weigth": "normal",
+ "wrap_length": "auto"
+ },
+ "optional": {
+ "pywal": true,
+ "sound": true
+ }
+}
+```
+
+---
+
+## Hardware Usage
+
+Pino is lightweight and efficient. The graphical notification window typically uses approximately **30MB of RAM** when active, ensuring minimal system resource consumption.
+
+---
+
+## Contributing
+Contributions are welcome! If you have ideas, feedback, or bug reports, contact me on Discord: **pi66**.
+
+---
+
+## License
+This project is licensed under an open license (add details if available).
|
