aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README39
1 files changed, 39 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..561ecb4
--- /dev/null
+++ b/README
@@ -0,0 +1,39 @@
+Conway's Game of Life Implementation
+====================================
+
+This is a synchronous cell-evolution simulation based on Conway's Game of
+Life rules, rendered using the SDL2 library.
+
+BUILD
+-----
+
+The project requires a C compiler (e.g., GCC or Clang) and the SDL2 development
+libraries installed on your system.
+
+To compile the source package manually:
+
+ $ gcc -O2 main.c -o game_of_life -lSDL2
+
+USAGE
+-----
+
+The binary accepts optional arguments to configure the viewport dimension parameters.
+If no arguments are provided, it defaults to 900x900.
+
+1. Execution with default dimensions:
+
+ $ ./game_of_life
+
+2. Execution with custom dimensions (e.g., 640x480):
+
+ $ ./game_of_life 640 480
+
+Runtime Interactivity:
+- Mouse Left Click : Spawn a live cell at the cursor's location.
+- Mouse Right Click : Erase a cell at the cursor's location.
+- Return/Enter Key : Lock cell initialization mode and initiate simulation loop.
+
+LICENSE
+-------
+
+See LICENSE. \ No newline at end of file