From adce82abbb5f0eaff4c6dc5b97af192ec8552eb6 Mon Sep 17 00:00:00 2001 From: Anthony Godin Date: Sun, 12 Feb 2017 13:41:32 +0100 Subject: [PATCH 1/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8c1d8b1..30405bb 100644 --- a/README.md +++ b/README.md @@ -13,4 +13,4 @@ Navigate to http://localhost:8080. You can to change the default port in `/src/main/resources/application.properties` ## Documentation -* [See the docs](https://github.com/M2GIL/IAtaaa-server/wiki/Communication) +* [See the docs](https://github.com/M2GIL/IAtaaa-server/wiki) From a762d2052e11f34ff0bb661213d121fd145f6d93 Mon Sep 17 00:00:00 2001 From: Yoann Fleury Date: Tue, 14 Feb 2017 10:33:37 +0100 Subject: [PATCH 2/2] docs(README.md): update README --- README.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 30405bb..0e6d6c7 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,24 @@ # Iataaa Server -Iataaa Server is web platform which manages draught game beetween web services. + +Iataaa Server is web platform to manage draughts AI. The name IAtaaa stands for the IA (Intelligence Artificielle in french) acronym and the Yatta japanese word for "We did it". + +## Requirements + +You need Maven on your system to run the platform. Maven is a tool for Java projects. Install it on your system using [this documentation](https://maven.apache.org/install.html). Make sure to have the mvn command on your path. ## Getting Started + ### Building the project -Execute `mvn clean install` in the root directory to build maven project. -### Deploy the project -Execute `mvn spring-boot:run` in the root directory to deploy spring boot project. +Execute `mvn clean install` in the root directory to build the Maven project. + +### Run the project -Navigate to http://localhost:8080. +Execute `mvn spring-boot:run` in the root directory to run the Spring-Boot project. +You need the [IAtaaa-client](https://github.com/M2GIL/IAtaaa-server) interface to add AI and run a game. You can also develop your own interface using the Web Service and Websocket provided by the server. -You can to change the default port in `/src/main/resources/application.properties` +The port can be configured in the `src/main/resources/application.properties` file. ## Documentation + * [See the docs](https://github.com/M2GIL/IAtaaa-server/wiki)