From b499ee1ecbda60d0ccd2ad5bd46c4805e34b6d63 Mon Sep 17 00:00:00 2001 From: James ABIB Date: Sat, 6 Jan 2024 16:44:44 +0100 Subject: [PATCH] doc(readme): Add options for verbose and debug log levels This commit adds options for using verbose and debug log levels in the server and client. The `README.md` file has been updated to include instructions on how to use these log levels. Now, users can run the server with verbose logs using `cargo run -p server -- -v`, or with debug logs using `cargo run -p server -- -d`. Similarly, they can run the client with verbose logs using `cargo run -p client -- -v`, or with debug logs using `cargo run -p client -- -d`. --- README.md | 26 ++++++++------------------ 1 file changed, 8 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 45cbebb..7f17a40 100644 --- a/README.md +++ b/README.md @@ -105,32 +105,22 @@ To run the server with CLI, use the following command: cargo run -p server -- -h ``` -## Using debug log level - -To use the debug log level, use the following command: +## Using verbose log level -### Unix/Linux/MacOS +To use the verbose log level, use the following command: ```bash -RUST_LOG=debug cargo run -p client -RUST_LOG=debug cargo run -p server +cargo run -p client -- -v +cargo run -p server -- -v ``` -### Windows - -#### CMD - -```bash -set RUST_LOG=debug -cargo run -p client -cargo run -p server -``` +## Using debug log level -#### PowerShell +To use the debug log level, use the following command: ```bash -$env:RUST_LOG="debug"; cargo run -p client -$env:RUST_LOG="debug"; cargo run -p server +cargo run -p client -- -d +cargo run -p server -- -d ``` ## Documentation