Documentation for developers and pupils

[soerendomroes]

Hi, I would like the following developer documentation and features:

1. Rust and cargo versions.
2. How to build, run and publish
3. How to run tests
4. What to update for a new game?

Moreover, I needed the following information to start this as a student (I will make a PR soonish regarding point 3):

1. How to set up a Rust IDE (and the project) -> I think we can assume that the pupils know this? Maybe not?
2. Rust and cargo versions. Maybe this is a me problem, but I used rust previously and had an older version of rust installed such that cargo init failed.
3. Clean up pupil docu and extract clear steps what to do. e.g. 1. Set up IDE, 2. import project, 3. cargo init, ...
4. I am confused that the code in the readme is different from the random player.
5. How do I debug my player?

[soerendomroes]

6. Can pupils disable the logging? Maybe an option would be nice.

[soerendomroes]

I suggest putting the developer docs in the wiki or a separate developer readme file, i.e., CONTRIBUTING.md such that readme is completely user facing.

[soerendomroes]

Is it planned to add point calculation? In the Java implementation, we support methods to get the points for the different teams.

Or do we want to let the teams the freedom to develop such functionality themselves?

[SturmEnte]

Is it planned to add point calculation? In the Java implementation, we support methods to get the points for the different teams.

Or do we want to let the teams the freedom to develop such functionality themselves?

We forgot about that.
I added it to the todo list: #12

[SturmEnte]

6. Can pupils disable the logging? Maybe an option would be nice.

There is currently no logging that I'm aware of that is build into the library that isn't a disabled by default feature.
The only logging that is not made by our examples is the communication logging into a file which is disabled if --features debug or --features debug-recv-comm-log isn't added to the start commands.

Did you find any debugging caused by the library and not the client?

[SturmEnte]

4. I am confused that the code in the readme is different from the random player.

The random player is a bit more complex then the test player.
I used the test player from the examples and not the random player so that the readme is shorter.

[SturmEnte]

Is it planned to add point calculation? In the Java implementation, we support methods to get the points for the different teams.
Or do we want to let the teams the freedom to develop such functionality themselves?

We forgot about that. I added it to the todo list: #12

Fixed