Browse Source

Add README and Makefile

Explain how the project should be used, and add convience
short cuts with make.
Oz N Tiram 4 years ago
parent
commit
10d0a2ea3b
2 changed files with 60 additions and 3 deletions
  1. 14 3
      Makefile
  2. 46 0
      README.md

+ 14 - 3
Makefile

@@ -1,7 +1,18 @@
 
-integration-test::
-	rover FFF
 
-test::
+install::
+	python3 setup.py install
+
+setup/venv::
+	python3 -m venv rover-venv
+
+setup/dev:: setup/venv
+	rover-venv/bin/pip install -r requirements.txt
+
+test/unit::
 	pytest -vv tests
 
+test/integration::
+	rover FFF
+
+

+ 46 - 0
README.md

@@ -0,0 +1,46 @@
+
+Mars Rover Kata - version 1.2
+=============================
+
+
+This is a solution to the Kata in Python3. 
+
+The requirements to run this code are:
+
+ * Python3 
+ * pip
+ * GNU Make (optional)
+
+To run the code create a virtual
+environment and install the dependecies and then the code itself. If you are
+familiar with Python you can also use Pipenv and skip the following instructions:
+
+```
+# These istructions assume you use a shell on a UNIX like system (Mac or Linux)
+$ python3 -m venv rover-env
+$ source rover-env/bin/activate
+$ pip install -r  requirements.txt
+```
+
+If you have GNU Make installed on your system you can simply use:
+
+```
+$ make setup/dev
+$ source rover/env/activate
+```
+
+USAGE
+-----
+To land the rover on mars:
+
+```
+$ rover land
+Landed on (7, 2) Facing East.
+```
+To move the rover
+```
+$ rover move FSF
+Moved to (8, 1) Facing South.
+```
+
+