README.md (1707B)
1 # Simple X Alert 2 <img src="https://mcdim.xyz/projects/sxalert/alectryon.png" alt="Alectryon rooster sxalert logo" style="height: 222px; width:200px;"/> 3 4 Simple notification system for X that works without a daemon. This is mainly for personal use, but I'll be glad to support whoever else wants to use it. Currently in development. 5 6 ## Features 7 + Alert & exit -- no daemon 8 + Freetype scalable fonts 9 + UTF-8 support 10 + Configurable & scriptable with shell 11 + Dynamic screen positioning & sizing 12 13 ## Dependencies 14 To build sxalert, you'll need a c99 compiler, `make`, `Xlib` and `Xft`. 15 16 ## Build & install 17 In order to build, execute the following commands: 18 ``` 19 $ git clone https://github.com/MichaelDim02/sxalert.git && cd sxalert 20 $ make sxalert 21 ``` 22 And to install on /bin: 23 ``` 24 $ sudo make install 25 ``` 26 27 ## Usage 28 You can simply run the tool with each argument being a line of text 29 ``` 30 $ ./sxalert "First line" "Second line" 31 ``` 32 You can also set color, border width & duration: 33 ``` 34 $ ./sxalert -d 1000 -b 5 -t FFFFFF -g 000000 -r FFFFFF "First line" "Second line" 35 ``` 36 These will overwrite the defaults defined in `config.h` 37 38 ## TODOs: 39 + Read from stdin (perhaps as a patch) 40 + <s>Exit by ButtonPress event</s> 41 42 ## Optional D-Bus daemon hack 43 I've created a small Shell script called [sxalertd](https://github.com/MichaelDim02/sxalertd) that can run as a daemon to read the D-Bus and use sxalert to draw the notifications. The script & parsing method are a little hacky but work quite well. 44 45 ## Credit 46 The logo is the Alectryon! The rooster image is by Leys, Thomson W. from the 1883 book "Brett's colonists' guide and cyclopaedia" for New Zealand settlers. The font is Byzantine, and the logo was created in GIMP.