summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBenjamin Chausse <benjamin@chausse.xyz>2020-01-09 16:24:50 -0500
committerBenjamin Chausse <benjamin@chausse.xyz>2020-01-09 16:24:50 -0500
commit4a18144b54bdec1c9d2d5a41839fb0fdec311c6d (patch)
treeed6fd0926f7e6603cce1b20b6ba56f396d17f639
parent1024cc390f5066c26c93a039c1b351762b73c378 (diff)
Added a README to the project
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..61495c7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+Battleship-go (WIP)
+---
+A terminal based batlleship game written in go.
+
+## About the project
+I started this project to expand my knowledge of the go
+programing language and have a little something to show
+for it at the end. When this project will be done, you
+should be able to play on a single computer a game of battleship
+in a sexy terminal interface.
+
+## Goals
+
+- [ ] Know Go better
+- [ ] Make a multiplayer game which can be played on a single computer
+- [ ] Have a clean, simple, and easy to use interface
+
+## Strech goals
+
+- [ ] Allow the game to be played v.s. a computer algorithm
+- [ ] Allow the game to be played on two different computers using SSH
+