sxalert

Simple notification system for X
git clone git://mcdim.xyz/sxalert.git
Log | Files | Refs | README | LICENSE

README.txt (2570B)

      1                                ~-.
      2              ,,,;            ~-.~-.~-
      3             (.../           ~-.~-.~-.~-.~-.
      4            <} o~`,         ~-.~-.~-.~-.~-.~-.
      5             (/    \      ~-.~-.~-.~-.~-.~-.~-.
      6              ;    \    ~-.~-.~-.~-.~-.~-.~-.
      7             ;     {_.~-.~-.~-.~-.~-.~-.~
      8            ;:  .-~`    ~-.~-.~-.~-.~-.
      9           ;.: :'    ._   ~-.~-.~-.~-.~-
     10            ;::`-.    '-._  ~-.~-.~-.~-
     11             ;::. `-.    '-,~-.~-.~-.
     12              ';::::.`''-.-'
     13                ';::;;:,:'
     14                   '||"
     15                   / |
     16                 ~` ~"'mic
     17 
     18                        '||                    .   
     19  ....  ... ...  ....    ||    ....  ... ..  .||.  
     20 ||. '   '|..'  '' .||   ||  .|...||  ||' ''  ||   
     21 . '|..   .|.   .|' ||   ||  ||       ||      ||   
     22 |'..|' .|  ||. '|..'|' .||.  '|...' .||.     '|.' 
     23       
     24 
     25 Simple X Alert 
     26  ____________________________________________________________
     27 | version 0.1 | language C | lines of code <200 | binaries 1 |
     28 
     29 Simple notification system for X that works without a daemon. This is mainly for
     30 personal use, but I'll be glad to support whoever else wants to use it.
     31 Currently in development.
     32 
     33 Features
     34 ========
     35 + Alert & exit -- no daemon
     36 + Freetype scalable fonts
     37 + UTF-8 support
     38 + Configurable & scriptable with shell
     39 + Dynamic screen positioning & sizing
     40 
     41 Dependencies
     42 ============
     43 To build sxalert, you'll need a c99 compiler, make, Xlib and Xft.
     44 
     45 Build & install
     46 ===============
     47 In order to build, execute the following commands:
     48 
     49 	$ git clone https://github.com/MichaelDim02/sxalert.git && cd sxalert
     50 	$ make sxalert
     51 
     52 And to install on /bin:
     53 
     54 	$ sudo make install
     55 
     56 Usage
     57 =====
     58 You can simply run the tool with each argument being a line of text
     59 
     60 	$ ./sxalert "First line" "Second line"
     61 
     62 You can also set color, border width & duration:
     63 
     64 	$ ./sxalert -d 1000 -b 5 -t FFFFFF -g 000000 -r FFFFFF "First line" "Second line"
     65 
     66 These will overwrite the defaults defined in `config.h`
     67 
     68 TODOs
     69 =====
     70 + Read from stdin (perhaps as a patch)
     71 + [DONE] Exit by ButtonPress event
     72 
     73 Optional D-Bus daemon hack
     74 ==========================
     75 I've created a small Shell script called sxalertd that can run as a daemon to
     76 read the D-Bus and use sxalert to draw the notifications. The script & parsing
     77 method are a little hacky but work quite well.
     78 (https://github.com/MichaelDim02/sxalertd) 
     79 
     80 Credit
     81 ======
     82 The logo is the Alectryon! The rooster image is by Leys, Thomson W. from the
     83 1883 book "Brett's colonists' guide and cyclopaedia" for New Zealand settlers.
     84 The font is Byzantine, and the logo was created in GIMP.