Skip to content

Commit a762d20

Browse files
docs(README.md): update README
1 parent 2b9dcd1 commit a762d20

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,24 @@
11
# Iataaa Server
2-
Iataaa Server is web platform which manages draught game beetween web services.
2+
3+
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".
4+
5+
## Requirements
6+
7+
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.
38

49
## Getting Started
10+
511
### Building the project
6-
Execute `mvn clean install` in the root directory to build maven project.
712

8-
### Deploy the project
9-
Execute `mvn spring-boot:run` in the root directory to deploy spring boot project.
13+
Execute `mvn clean install` in the root directory to build the Maven project.
14+
15+
### Run the project
1016

11-
Navigate to http://localhost:8080.
17+
Execute `mvn spring-boot:run` in the root directory to run the Spring-Boot project.
18+
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.
1219

13-
You can to change the default port in `/src/main/resources/application.properties`
20+
The port can be configured in the `src/main/resources/application.properties` file.
1421

1522
## Documentation
23+
1624
* [See the docs](https://github.com/M2GIL/IAtaaa-server/wiki)

0 commit comments

Comments
 (0)