commit 9c4dbc1e22ffa1f6b3a3bc3b74a5b22eb7106a76
parent df6153bd4daf6c4d8692fee780c27edaf3d50463
Author: Brian C. Lane <bcl@brianlane.com>
Date: Sat, 26 Nov 2022 09:50:47 -0800
README: Add notes about the window size
Diffstat:
1 file changed, 12 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
@@ -1,3 +1,5 @@
+# sdl2-life
+
[Conway's Game of Life](https://www.conwaylife.com/wiki/Conway's_Game_of_Life)
This implementation uses a [SDL2 Go library](https://github.com/veandco/go-sdl2/) to draw the world.
@@ -9,7 +11,15 @@ This implementation uses a [SDL2 Go library](https://github.com/veandco/go-sdl2/
* Pass '-empty' to start with an empty world, this is useful when combined with '-server' which normally starts
with a random seed.
-== Server
+The window size (width, height) should be evenly divisible by columns and rows
+respectively. Otherwise the cell size is rounded down, so that they are square,
+and the world may not use all of the available space.
+
+Resizing the window with a window manager is likely to also cause problems --
+this code was written suing dwm and a floating window with no decorations so I
+haven't added any resize support.
+
+## Server
Passing '-server' will listen to port 3051 for pattern files to be POSTed to it. This supports the same formats
as the cmdline -pattern argument (Life 1.05 and plain text). You can easily send it a pattern file using curl like
@@ -17,7 +27,7 @@ this:
curl --data-binary @./examples/glider-gun-1.05.life http://127.0.0.1:3051/
-== Building
+## Building
Run `go build`
