fixup

jarpoole · Dec 29, 2022 · 575311a · 575311a
1 parent 60ccc2f
commit 575311a
Show file tree

Hide file tree

Showing 7 changed files with 99 additions and 170 deletions.
diff --git a/Makefile b/Makefile
@@ -0,0 +1,9 @@
+CC=gcc
+EXE=jsnake.app
+LFLAGS=-lcurses
+
+$(EXE):
+	$(CC) ./src/main.c $(LFLAGS) -o $(EXE)
+
+clean:
+	rm -rf $(EXE)
diff --git a/README.md b/README.md
@@ -0,0 +1,37 @@
+# jsnake-v1
+
+This project is the first game and likely even full program I ever wrote in C. Its very rough around the edges but definitely playable.
+
+![play](./docs/play.png)
+
+## Features
+
+1. Score keeping
+2. Single-player mode (`[UP][LEFT][RIGHT][DOWN]` against computer)
+3. Two-player mode (`wasd` and `[UP][LEFT][RIGHT][DOWN]`)
+
+## Dependencies
+
+Install `ncurses`. On debian based distros like ubuntu for example:
+
+```bash
+apt-get install libncurses5-dev
+```
+
+Install build tools. On debian based distros like ubuntu for example:
+
+```bash
+sudo apt install gcc make
+```
+
+## Play
+
+The game expects an approximately 16x9 aspect ratio for the terminal. Make sure to resize the window as appropriate.
+
+```bash
+make
+./jsnake.app
+```
+
+![menu](./docs/menu.png)
+![score](./docs/score.png)
diff --git a/a.out b/a.out
diff --git a/docs/menu.png b/docs/menu.png
diff --git a/docs/play.png b/docs/play.png
diff --git a/docs/score.png b/docs/score.png