Choose name#268

NOTICE

@@ -1,4 +1,4 @@
-lrozenblyum-chess
+Leokom Chess
 Copyright 2012-2019 Leonid Rozenblium
 
 Licensed under the Apache License, Version 2.0 (the "License");

README.md

@@ -1,5 +1,15 @@
 ## Goal
-The chess software that is developed for fun.
+**Leokom Chess** is a Java-based chess engine.
+The engine is using Chess Engine Communication Protocol for communication with any existing GUI that supports the protocol.
+
+## Not a goal
+**Leokom Chess** doesn't include any GUI.
+If you are a bot you can play with it using command line :)
+If you are a human being you should deploy it to your favourite Chess GUI software. 
+
+## Motivation
+The chess software is developed for fun.
+It should proof that OOP and TDD principles can lead to quality game software.
 
 ## Creator
 Initial creator is Leonid Rozenblyum

pom.xml

@@ -3,12 +3,12 @@
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
-
-    <name>Chess</name>
     <groupId>com.leokom</groupId>
     <artifactId>Chess</artifactId>
     <version>0.6-SNAPSHOT</version>
 
+    <name>Leokom Chess</name>
+    <inceptionYear>2012</inceptionYear>
 
     <!-- Added in order to support github-release-plugin.
     This information is also useful itself for semantic purposes.
@@ -126,7 +126,7 @@
 
 
     <build>
-    	<finalName>Chess</finalName>
+    	<finalName>${brandName}</finalName>
         <plugins>
             <!-- Additionally configuring maven clean plug-in in order to clean the deploy directory and thus remove potential old artifacts -->
             <plugin>
@@ -353,10 +353,11 @@
         <!-- Naming convention inspired by http://stackoverflow.com/a/30318342/1429367 -->
         <log4j2version>2.11.1</log4j2version>
 
-        <project.deployDirectory>E:\Games\WinBoard-4.8.0\LeokomChess</project.deployDirectory>
+        <project.deployDirectory>E:\Games\WinBoard-4.8.0\${brandName}</project.deployDirectory>
 
         <dependenciesDirectory>lib</dependenciesDirectory>
-
-        <binaryReleaseName>LeokomChess-${project.version}</binaryReleaseName>
+        <!-- The variable defines chess brand without spaces, should be used for building various artifacts -->
+        <brandName>LeokomChess</brandName>
+        <binaryReleaseName>${brandName}-${project.version}</binaryReleaseName>
     </properties>
 </project>

src/main/bat/runTwoEngines.bat

@@ -8,8 +8,9 @@
 cd %~p0
 
 call variables.bat
-SET RUNNABLE_JAR_DIRECTORY_2=%WINBOARD_INSTALLATION_PATH%\LeokomChessTest
-SET RUN_JAR_PATH_2=%RUNNABLE_JAR_DIRECTORY_2%\Chess.jar
+SET RUNNABLE_JAR_DIRECTORY_2=%WINBOARD_INSTALLATION_PATH%\%BRAND_NAME%Test
+@rem for Chess <= 0.5 you should use Chess.jar instead of %BRAND_NAME%.jar for running
+SET RUN_JAR_PATH_2=%RUNNABLE_JAR_DIRECTORY_2%\%BRAND_NAME%.jar
 
 @rem you may specify -Dblack.engine=brain.simple or brain.denormalized for Chess 0.5+
 @rem you may specify -Dblack.engine=Simple for Chess 0.4

src/main/bat/variables.bat

@@ -13,8 +13,9 @@ SET JAVA_PATH=Q:\Program Files\Java\jdk1.8.0_162\bin\java.exe
 SET WINBOARD_PATH=%WINBOARD_INSTALLATION_PATH%\WinBoard\winboard.exe
 @rem I use the Winboard installation as a Chess deployment target
 @rem it should be equal to 'project.deployDirectory' property in pom.xml
-SET RUNNABLE_JAR_DIRECTORY=%WINBOARD_INSTALLATION_PATH%\LeokomChess
-SET RUN_JAR_PATH=%RUNNABLE_JAR_DIRECTORY%\Chess.jar
+SET BRAND_NAME=LeokomChess
+SET RUNNABLE_JAR_DIRECTORY=%WINBOARD_INSTALLATION_PATH%\%BRAND_NAME%
+SET RUN_JAR_PATH=%RUNNABLE_JAR_DIRECTORY%\%BRAND_NAME%.jar
 @rem you may pass -Dblack.engine=brain.simple or brain.denormalized to choose a different engine for blacks
 @rem for brain.normalized you may specify -Dblack.depth (1 or 2)
 SET RUN_OPTIONS=-Dblack.depth=2

src/main/java/com/leokom/chess/MainRunner.java

@@ -14,6 +14,7 @@ private MainRunner() {
 	}
 
 	private static final Logger logger = LogManager.getLogger( MainRunner.class );
+	private static final String BRAND_NAME = "Leokom Chess";
 
 	/**
 	 * Start whole chess program
@@ -69,11 +70,11 @@ private MainRunner() {
 	 */
 	public static void main( String[] args ) {
 		try {
-			logger.info( "Starting the chess..." );
+			logger.info( "Booting {}...", BRAND_NAME );
             new Game(
                 new CommandLinePlayers()
             ).run();
-            logger.info( "Chess are stopped. Bye-bye" );
+            logger.info( "{} successfully completed its job. Bye-bye", BRAND_NAME );
 		}
 		catch ( RuntimeException re ) {
 			//important to investigate issues