Move doc comment from main.rs to lib.rs

iahmadgad · Sep 20, 2024 · 793b364 · 793b364
1 parent cf8831f
commit 793b364
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 33 deletions.
diff --git a/rock-paper-scissors/src/lib.rs b/rock-paper-scissors/src/lib.rs
@@ -1,3 +1,34 @@
+//! > Rock Paper Scissors written in Rust
+//! # Guide
+//! firstly run this crate via cargo:
+//! ```sh
+//! cargo run --package rock-paper-scissors
+//! ```
+//! then it will prompt you for play mode, whether singleplayer or multiplayer:
+//! ```sh
+//! Rock Paper Scissors by Ahmad
+//! choose play mode:
+//! 1. singleplayer
+//! 2. multiplayer
+//! input: 
+//! ```
+//! Type `1` for singleplayer or `2` for multiplayer.
+//! //! If you chose multiplayer it will prompt you for player names:
+//! ```sh
+//! player: 
+//! ```
+//! then it will prompt you for max points number:
+//! ```sh
+//! Enter max points number: 
+//! ```
+//! Supposing you typed `3` it will continue to run the game & prompt each turn for player's choice until someone gets `3` points.
+//! this are valid choices:
+//! | Choice | Alias |
+//! | -------- | ------- |
+//! | `rock` | `r` |
+//! | `paper` | `p` |
+//! | `scissors` | `s` |
+
 pub mod choice;
 pub mod game;
 pub mod mode;

diff --git a/rock-paper-scissors/src/main.rs b/rock-paper-scissors/src/main.rs
@@ -1,36 +1,3 @@
-//! > Rock Paper Scissors written in Rust
-//! # Guide
-//! firstly run this crate via cargo:
-//! ```sh
-//! cargo run --package rock-paper-scissors
-//! ```
-//! then it will prompt you for play mode, whether singleplayer or multiplayer:
-//! ```sh
-//! Rock Paper Scissors by Ahmad
-//! choose play mode:
-//! 1. singleplayer
-//! 2. multiplayer
-//! input: 
-//! ```
-//! Type `1` for singleplayer or `2` for multiplayer.
-//! //! If you chose multiplayer it will prompt you for player names:
-//! ```sh
-//! player: 
-//! ```
-//! then it will prompt you for max points number:
-//! ```sh
-//! Enter max points number: 
-//! ```
-//! Supposing you typed `3` it will continue to run the game & prompt each turn for player's choice until someone gets `3` points.
-//! this are valid choices:
-//! | Choice | Alias |
-//! | -------- | ------- |
-//! | `rock` | `r` |
-//! | `paper` | `p` |
-//! | `scissors` | `s` |
-
-
-
 pub use rock_paper_scissors::{choice::Choice, game::Game, mode::Mode, util::mreadln};
 
 fn main() {