diff --git a/README.md b/README.md index d6a8a74..8eaf1d3 100644 --- a/README.md +++ b/README.md @@ -1 +1,42 @@ -# toy-bot \ No newline at end of file +# toy-bot + +Many thanks to [Lorenzo Sisini](https://github.com/lorenzosisini) for this beautiful experience. + + +#### Requirements +- maven 3 +- oracle JDK 8 + +#### Quick start +- clone the repository +```bash +git clone https://github.com/poweronoff/toy-bot.git +``` +- build the project +````bash +mvn clean package +```` +- run it +```bash +java -jar target/de.dj_steam.toybot--jar-with-dependencies.jar +``` + +#### Toy-Bot Reference +```bash +Commands: +PLACE X,Y,F - place robot on position X,Y - coordinates, and direction (NORTH|SOUTH|WEST|EAST) +MOVE - move the robot to the next field in facing direction +LEFT - turn the robot to the left +RIGHT - turn the robot to the right +REPORT - show robots position and facing direction +exit - exit the application +``` + +#### Further plans and implementation road +- refactoring and rework MoveStrategy +- implement JUMP command +- implement TURN_AROUND command +- user interface +- add random pitfalls or barriers to the field + + diff --git a/src/main/java/de/dj_steam/bot/cli/LoopingConsole.java b/src/main/java/de/dj_steam/bot/cli/LoopingConsole.java index 4474b27..ed982bc 100644 --- a/src/main/java/de/dj_steam/bot/cli/LoopingConsole.java +++ b/src/main/java/de/dj_steam/bot/cli/LoopingConsole.java @@ -63,7 +63,7 @@ public class LoopingConsole { System.out.println("####################################################"); System.out.println("Commands:"); System.out.println("PLACE X,Y,F - place robot on position X,Y - coordinates, and direction (NORTH|SOUTH|WEST|EAST)"); - System.out.println("MOVE - change the robot to the next field in facing direction"); + System.out.println("MOVE - move the robot to the next field in facing direction"); System.out.println("LEFT - turn the robot to the left"); System.out.println("RIGHT - turn the robot to the right"); System.out.println("REPORT - show robots position and facing direction");