Add README & LICENSE

2 files changed, 90 insertions, 0 deletions

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..e62f2ad
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Teddy Wing
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..111cdc2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,69 @@
+tic-tac-toe
+===========
+
+A simple incomplete 2-player tic-tac-toe game that runs in the console.
+
+Written originally as a possible vehicle or exercise for teaching test-driven
+development.
+
+
+## Requirements
+Developed with Ruby 2.1.2. Appears to work on Ruby 1.9.3.
+
+
+## Running
+	$ ruby main.rb
+
+
+## Example
+	$ ruby main.rb 
+	...
+	...
+	...
+	
+	Player X move - Enter coordinates (e.g. 0,2): 1,2
+	----
+	...
+	..X
+	...
+	
+	Player O move - Enter coordinates (e.g. 0,2): 0,0
+	----
+	O..
+	..X
+	...
+	
+	Player X move - Enter coordinates (e.g. 0,2): 0,1
+	----
+	OX.
+	..X
+	...
+	
+	Player O move - Enter coordinates (e.g. 0,2): 1,0
+	----
+	OX.
+	O.X
+	...
+	
+	Player X move - Enter coordinates (e.g. 0,2): 2,1
+	----
+	OX.
+	O.X
+	.X.
+	
+	Player O move - Enter coordinates (e.g. 0,2): 2,0
+	----
+	OX.
+	O.X
+	OX.
+	Player O wins
+
+
+## Known Issues
+* Entering invalid coordinates (whether a coordinate outside the board or a
+  value that isn't a coordinate) causes an exception and exits immediately.
+* Game does not check for a tie
+
+
+## License
+Licensed under the MIT License. See the included LICENSE file.