<commit_before># Robot-Simulator

Simulation of toy robot moving on a square tabletop

A robot is placed on a 5x5 tabletop. Instructions are issued to the robot via user input or via a text input file

## Environments

Initially developed on

* Windows 10
* JRE 8 U73
* Maven 3.3.9

## System dependencies and configuration

* JRE => 8U73

## Usage Instructions

Load command prompt and change to working directory of robotsim class files

To run application in interactive mode:

java -jar jarfile

_example._ java -jar robotsim-0.0.1-SNAPSHOT.jar

To run application from an input file:

java -jar jarfile pathtoinputfile

_example._ java -jar robotsim-0.0.1-SNAPSHOT.jar pathtoinputfile

## Valid commands

Note: Commands for interactive and input file are identical

#####PLACE X,Y,DIRECTION

**Purpose:** Places robot on tabletop. Only valid if robot is not on board already, will be discard otherwise.

X = X coordinate on tabletop to place robot. Valid inputs: 0-4
Y = Y coordinate on tabletop to place robot. Valid inputs: 0-4
DIRECTION = Direction for robot to face. Valid inputs are NORTH, SOUTH, EAST, WEST

#####MOVE

**Purpose:** Move robot one unit forward in the direction it is currently facing.

Only valid if movement does not take robot off the tabletop edge.

#####LEFT

**Purpose:** Rotate the robot 90 degrees to the left

_example_ Robot is facing north, LEFT is issued, robot is now facing WEST

#####RIGHT

**Purpose:** Rotate the robot 90 degrees to the right

_example_ Robot is facing north, RIGHT is issued, robot is now facing EAST

#####REPORT

**Purpose:** Reports the location of the robot and direction the robot is facing

_example_

REPORT
3,3,NORTH

## Compiling from source

Maven needs to be installed and working.

1. Download source (via zip or clone repository)
2. Browse to source root
3. Run the following to compile from source

    ```console
	$ mvn compile
	```

## Creating executable jar

1. Download source (via zip or clone repository)
2. Browse to source root
3. Run "mvn package" to compile and package from source

## Running tests

1. Browse to source root
2. Run "mvn test" to execute tests

## Overview


## Design Choices

## License

[![CC0](https://licensebuttons.net/p/zero/1.0/88x31.png)](http://creativecommons.org/publicdomain/zero/1.0/)

## Conclusion

<commit_msg>README.md changes.<commit_after># Robot-Simulator

Simulation of toy robot moving on a square tabletop

A robot is placed on a 5x5 tabletop. Instructions are issued to the robot via user input or via a text input file

## Environments

Initially developed on

* Windows 10
* JRE 8 U73
* Maven 3.3.9

## System dependencies and configuration

* JRE => 8U73

## Usage Instructions

Load command prompt and change to working directory of robotsim class files

To run application in interactive mode:

java -jar jarfile

_example._ java -jar robotsim-0.0.1-SNAPSHOT.jar

To run application from an input file:

java -jar jarfile pathtoinputfile

_example._ java -jar robotsim-0.0.1-SNAPSHOT.jar pathtoinputfile

## Valid commands

Note: Commands for interactive and input file are identical

#####PLACE X,Y,DIRECTION

**Purpose:** Places robot on tabletop. Only valid if robot is not on board already, will be discard otherwise.

X = X coordinate on tabletop to place robot. Valid inputs: 0-4
Y = Y coordinate on tabletop to place robot. Valid inputs: 0-4
DIRECTION = Direction for robot to face. Valid inputs are NORTH, SOUTH, EAST, WEST

#####MOVE

**Purpose:** Move robot one unit forward in the direction it is currently facing.

Only valid if movement does not take robot off the tabletop edge.

#####LEFT

**Purpose:** Rotate the robot 90 degrees to the left

_example_ Robot is facing north, LEFT is issued, robot is now facing WEST

#####RIGHT

**Purpose:** Rotate the robot 90 degrees to the right

_example_ Robot is facing north, RIGHT is issued, robot is now facing EAST

#####REPORT

**Purpose:** Reports the location of the robot and direction the robot is facing

_example_

REPORT
3,3,NORTH

## Compiling from source

Maven needs to be installed and working.

1. Download source (via zip or clone repository)
2. Browse to source root
3. Run the following to compile from source

    ```console
	$ mvn compile
	```

## Creating executable jar

1. Download source (via zip or clone repository)
2. Browse to source root
3. Run the following to compile and package from source

    ```console
	$ mvn package
	```

## Running tests

1. Browse to source root
2. Run the following to execute tests

    ```console
	$ mvn test
	```

## Overview


## Design Choices

## License

[![CC0](https://licensebuttons.net/p/zero/1.0/88x31.png)](http://creativecommons.org/publicdomain/zero/1.0/)

## Conclusion


{'fraction_non_alphanumeric': 0.07979734008866371, 'fraction_numerical': 0.019421574836394343, 'mean_word_length': 4.00845665961945, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 5, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5638467', 'n_tokens_mistral': 1503, 'n_tokens_neox': 1407, 'n_words': 665}