Merge branch 'master' of https://github.com/AlexWang18/Chess

.gitignore

@@ -1,9 +1,12 @@
 # ignore json file types
 *.json
 /settings/
+<<<<<<< HEAD
 # Compiled class file
 
 .vscode
+=======
+>>>>>>> c562d0ce06455181f4b54bf65d6f74749cc61844
 
 # Log file
 *.log
@@ -15,6 +18,10 @@
 .mtj.tmp/
 
 # Package Files #
+<<<<<<< HEAD
+=======
+
+>>>>>>> c562d0ce06455181f4b54bf65d6f74749cc61844
 *.war
 *.nar
 *.ear

README.md

@@ -3,30 +3,35 @@
 ### By Alex Wang ([email protected])
 
 ## Installation Instructions:
+To get a local copy up and running follow these simple steps.
 Clone the project https://github.com/AlexWang18/Chess.git
-Run java -jar target/test-classes/domain/chess-1.jar
+
+```bash 
+# To start a match 
+java -jar target/test-classes/domain/chess-1.jar
+```
 
 ---
 
 ## Features:
 ---
-Allows for PvP games using standard chess rules and no rules alike. Comes with castling, pawn promotion, and En Passant
+Allows for PvP games using standard chess rules and no rules alike. Simply enter the letter and number of the piece you want to move and the coordinates you want to move to. Comes with castling, pawn promotion, and En Passant
 Has robust error detection that prevents the match from crashing.
 ## Starting
 Welcome to CL Chess!
 What style of rules do you want to play?
 Classic, Silly, or None
 classic
 Let's begin
-1 ♖ ♘ ♗ ♕ ♔ ♗ ♘ ♖
-2 ♙ ♙ ♙ ♙ ♙ ♙ ♙ ♙
-3 - - - - - - - -
-4 - - - - - - - -
-5 - - - - - - - -
-6 - - - - - - - -
-7 ♟︎ ♟︎ ♟︎ ♟︎ ♟︎ ♟︎ ♟︎ ♟︎
-8 ♜ ♞ ♝ ♛ ♚ ♝ ♞ ♜
- a b c d e f g h
+1 ♖ ♘ ♗ ♕ ♔ ♗ ♘ ♖ 
+2 ♙ ♙ ♙ ♙ ♙ ♙ ♙ ♙ 
+3 - - - - - - - - 
+4 - - - - - - - - 
+5 - - - - - - - - 
+6 - - - - - - - - 
+7 ♟︎ ♟︎ ♟︎ ♟︎ ♟︎ ♟︎ ♟︎ ♟︎ 
+8 ♜ ♞ ♝ ♛ ♚ ♝ ♞ ♜ 
+ a b c d e f g h 
 
 ## Castling
 
@@ -36,7 +41,7 @@ Let's begin
 
 ## ThreeFold repetition
 ## What I've learned:
-This was my first personal project spurred on from binging Queen's Gambit. I dabbled a bit in Regex, design patterns, and the general principles of OOP in this project. It has definitely ingrained into me some useful lessons. For one having a plan with your idea is key and drawing out a UML can be especially useful. Another is to only work on a problem one at a time and finish that thoroughly before moving on. I've definitely also learned the importance of having readable and formatted code as was a pain to try to parse through some of my spaghetti code. Frequently when debugging I found myself writing more code instead of getting rid of the faulty ones. I could have definitely done a lot more differently with the high level implementation and perhaps added a GUI but I am overall pleased with how it turned out. 
+This was my first personal project spurred on from binging Queen's Gambit. I dabbled a bit in Regex, design patterns, Maven and the general principles of OOP in this project. It has definitely ingrained into me some useful lessons. For one having a plan with your idea is key and drawing out a UML can be especially useful. Another is to only work on a problem one at a time and finish that thoroughly before moving on. I've definitely also learned the importance of having readable and formatted code as was a pain to try to parse through some of my spaghetti code. Frequently when debugging I found myself writing more code instead of getting rid of the faulty ones. I could have definitely done a lot more differently with the high level implementation and perhaps added a GUI but I am overall pleased with how it turned out. 
 
 ## License:
 ---