abg

Animated background for X11
git clone git://git.laack.co/abg.git
Log | Files | Refs | README | LICENSE

README (1097B)


      1 abg - animated background
      2 =========================
      3 A program that executes Prim's algorithm, rendering each step using raylib, set
      4 as an X11 background.
      5 
      6 
      7 Requirements
      8 ============
      9 C++ compiler, X11, raylib, make
     10 
     11 
     12 Installation
     13 ============
     14 Edit config.mk to match your local setup if necessary for building (abg will be
     15 installed into /usr/local/bin by default).
     16 
     17 Then run the following command to build and install abg:
     18     make install
     19 
     20 (the above command may require root, depending on the installation location)
     21 
     22 
     23 Usage
     24 =====
     25     Usage: abg [--help] [--version] [--vertices VAR] [--sleep VAR] [--edges VAR]
     26 
     27     Optional arguments:
     28       -h, --help     shows help message and exits
     29       -v, --version  prints version information and exits
     30       --vertices     number of vertices in the graph
     31       -s, --sleep    amount of time to sleep between traversals
     32       -e, --edges    number of edges in the graph
     33 
     34 
     35 Examples
     36 ========
     37     abg --edges 50 --vertices 10
     38     abg --edges 1500 --vertices 1000
     39 
     40 
     41 Configuration
     42 =============
     43 The configuration of abg is done via modifying the source code.