README - fracwall - This fractal wallpaper generator creates a bitmap file depicting either the Mandelbrot or the Julia set

README (2229B)
      1 Fractal Wallpaper Generator
      2 "fracwall"
      3 M. Yamanaka
      4 email: myamanaka@live.com
      5 website: csmyamanaka.com
      6 license: MIT (See included "LICENSE" file for details)
      7 
      8 Description:
      9 ============
     10 Have you just installed Arch Linux and your favourite window manager? Have you installed all the programs
     11 you need to make your workflow precisely how you like it? Don't like downloading random wallpapers from the
     12 internet but still want something epic to compliment your desktop setup? Why not make your own?
     13 The fractal wallpaper generator allows you to create a bitmap image of a complex fractal (Mandelbrot or Julia)
     14 so that you can add a homemade, and may I say, sophisticated looking wallpaper to decorate your awesome setup.
     15 
     16 Acknowledgment:
     17 ===============
     18 I found the following two videos by the youtube channel "The Mathemagicians' Guild" extremely helpful
     19 in understanding the mathematical background of the Mandelbrot and Julia sets.
     20   [1] "The Mandelbrot Set Explained" <https://www.youtube.com/watch?v=7MotVcGvFMg>
     21   [2] "Julia Sets, and how they relate to The Mandelbrot Set" <https://www.youtube.com/watch?v=dctJ7ISkU-4>
     22 
     23 Additionally, I have employed a design concept from Suckless Software  <https://suckless.org>
     24 where the configuration file is a component of the source code.
     25 Please note, that unlike your typical Suckless software, I use a source and header for the configuration (i.e. there is a config.c and a config.h).
     26 The file to edit it "config.c".
     27 Please DO NOT edit "config.h"!
     28 
     29 Dependencies:
     30 =============
     31 File IO ++ "fileiopp" from my repositories <git.csmyamanaka.com/fileiopp>
     32 
     33 Installation:
     34 =============
     35 Edit the Makefile included in fracwall so that the "FIOPPDIR" variable points to the fileiopp directory.
     36 
     37 After that, compile the program with
     38 
     39   make
     40 
     41 Uninstall:
     42 =========
     43 Get rid of binaries, *.o, and *.bmp files with
     44 
     45   make clean
     46 
     47 Usage:
     48 ======
     49 Edit the configuration file, "config.c", to your liking by modifying variables corresponding to screen size,
     50 complex number plane render window, Julia set fractal parameters, etc.
     51 
     52 Run the compiled program with
     53 
     54   ./Fracwall
     55 
     56 This creates a bitmap file ("wallpaper.bmp" by default) which can then be set as a desktop wallpaper
     57 using hsetroot for example.
     58 
     59