summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKai Stevenson <kai@kaistevenson.com>2023-03-20 14:23:49 -0700
committerKai Stevenson <kai@kaistevenson.com>2023-03-20 14:25:15 -0700
commit3c52be1b11c5c3feb0f4bcdbbeeb99b97e98a30e (patch)
treea3d371a3860c3279a11c0678cdc4b7f1e506a363
parent00616a58eaebc8840b73c3745a70e6b5f6fac77d (diff)
renamed project to chess3, updated readme
-rw-r--r--.gitignore2
-rw-r--r--Makefile6
-rw-r--r--README28
3 files changed, 31 insertions, 5 deletions
diff --git a/.gitignore b/.gitignore
index 0e1eadf..6f39861 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,4 @@
a.out
a.exe
*.swp
-chess
+chess3
diff --git a/Makefile b/Makefile
index 5fdc73e..12d2617 100644
--- a/Makefile
+++ b/Makefile
@@ -4,10 +4,10 @@ CFLAGS+= -Wshadow -Wundef -Wcast-align
CFLAGS+= -Wunreachable-code -Wswitch-enum
generate:
- $(CC) -o chess src/chess.c src/vector.c src/chesshelpers.c src/console.c src/fscomch.c $(CFLAGS)
+ $(CC) -o chess3 src/chess.c src/vector.c src/chesshelpers.c src/console.c src/fscomch.c $(CFLAGS)
install:
- cp chess /usr/local/bin/
+ cp chess3 /usr/local/bin/
clean:
- -rm chess
+ -rm chess3
diff --git a/README b/README
index 9db608a..89c1e90 100644
--- a/README
+++ b/README
@@ -1 +1,27 @@
-Simple chess interface. Will probably support networking.
+Chess3
+---------------------------------------
+
+This is a simple chess game written in C. It is written
+without ncurses or curses.
+
+The game supports communication between processes
+through a duplexed filestream interface. See src/fscomch.
+
+Install
+---------------------------------------
+
+In the root directory of the repository, run `make` and
+`make install`. There are no dependencies.
+
+Play
+---------------------------------------
+
+Open two instances of the chess3 binary. The first will
+play white, the second will play black. Follow the on-screen
+instructions.
+
+License
+---------------------------------------
+
+This program is licensed under the MIT license. See
+`LICENSE` for more information.