From be454cce030adf5792c43a8982c5e609b1a9e5b7 Mon Sep 17 00:00:00 2001 From: Pierre Hubert Date: Mon, 17 Oct 2022 20:29:41 +0200 Subject: [PATCH] Update READMEs --- README.md | 3 ++- rust/sea_battle_cli_player/README.md | 4 ++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b933e5a..fb18390 100644 --- a/README.md +++ b/README.md @@ -12,5 +12,6 @@ Current implementations: - [ ] mobile implementation ## Screenshots -Shell implementation: + +### Shell implementation ![Shell implementation example](rust/sea_battle_cli_player/img/SeaBattleCli.png) diff --git a/rust/sea_battle_cli_player/README.md b/rust/sea_battle_cli_player/README.md index 381422a..0dddf17 100644 --- a/rust/sea_battle_cli_player/README.md +++ b/rust/sea_battle_cli_player/README.md @@ -5,7 +5,7 @@ ![](img/SeaBattleCli.png) -A sea battle shell client player for the [sea_battle_backend](https://crates.io/crates/sea_battle_backend) crate. +A sea battle shell client player for the [sea_battle_backend](https://crates.io/crates/sea_battle_backend) crate, based on the [tui](https://crates.io/crates/tui) library. ## Available play modes * 🤖 Play against bot (this mode does not require any Internet connection, a local server is automatically spawn) @@ -13,7 +13,7 @@ A sea battle shell client player for the [sea_battle_backend](https://crates.io/ * ➕ Create play invite (online). In this mode, the server returns an invitation code to give to the opponent * 🎫 Accept play invite (online) -For the 🤖 bot mode and the ➕ bot mode, game rules can be customized. +For the 🤖 bot and ➕ create invite modes, game rules can be customized before starting the game. ## Installation You can install the backend using the following command: