gol

Implementation of Conway's Game of Life writen in C
git clone git://git.dimitrijedobrota.com/gol.git
Log | Files | Refs | README

README.md (2179B)

      1 # Game of Life Simulation
      2 
      3 This is an implementation of Conway's Game of Life in C for a university project
      4 
      5 
      6 ## About the Project
      7 
      8 This project is command line application written in C using the ncurses library
      9 to display GUI in the terminal. Project works both on Unix and Windows systems.
     10 
     11 Features:
     12 - Graphics:
     13   - Every menu is completely responsive
     14   - Unicode and No Unicode mode
     15 
     16 - Multiple game modes:
     17   - Normal
     18   - Coexistence
     19   - Predator
     20   - Unknown
     21   - Virus
     22 
     23 - Game:
     24   - Custom display interval
     25   - Custom speed
     26   - Movable cursor
     27   - Movable screen
     28   - Optional mouse support in game
     29   - Status line with information about the game
     30   - Visual select mode
     31 
     32 - Save/Load system:
     33   - Save/Load complete system
     34   - Save/Load part of the system
     35 
     36 - Variable size system:
     37   - Enter a custom size for the system, or
     38   - Play on infinite sized simulation
     39 
     40 - Help menu:
     41   - Information about the game
     42   - Cheatsheet with common cell patterns
     43 
     44 - Documentation:
     45   - html documentation using doxygen
     46   - pdf documentation using doxygen and pdflatex
     47 
     48 
     49 ## Prerequisites
     50 
     51 - C compiler
     52 - Make
     53 - ncurses (pdcurses on Windows)
     54 - doxygen and pdflatex (if you want to build documentation)
     55 
     56 
     57 ## How to build
     58 
     59 Clone the repository with, and enter the directory
     60 
     61 ```
     62 git clone https://www.github.com/DimitrijeDobrota/GameofLife
     63 cd GameofLife
     64 ```
     65 
     66 See `Makefile` for the build script.
     67 To get information about all build options run `make help`.
     68 
     69 To build the project, simply run `make` at the command line in the current directory.
     70 
     71 By default, this will generate an executable called whatever `NAME`
     72 is bound to in `Makefile` (by default, `gol`), using `CC` compiler (by default, `gcc`).
     73 To then run the program, type in
     74 
     75 ```
     76 ./bin/gol
     77 ```
     78 
     79 in the project directory.
     80 
     81 To compile the debugging version of the executable, run `make DEBUG=Y`.
     82 You can also give the optional parameter `NO_UNICODE=Y`, to build the executable without Unicode support.
     83 
     84 
     85 ## Running the project
     86 
     87 In the `./bin` directory you will find the executable, and you can run it with
     88 
     89 ```
     90 ./bin/gol
     91 ```
     92 
     93 If you are on Windows you can double click on `gol.exe` inside `./bin` and
     94 terminal window will pop-up with the game