From 66dd219b78be3cdcf74ca34e7616eb74de7457d5 Mon Sep 17 00:00:00 2001 From: Xevion Date: Sun, 12 Jun 2022 15:27:54 -0500 Subject: [PATCH] Improve README with build/development details --- README.md | 39 +++++++++++++++++++++++++-------------- 1 file changed, 25 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 8633932..692cfaa 100644 --- a/README.md +++ b/README.md @@ -13,21 +13,32 @@ pipenv install ## Usage -I like to use Windows Terminal to run both a server and client simultaneously inside one window. +```bash +python launch.py [c | s | server | client] +``` + +## Building ```bash +make build + +# optional +make clean +``` + +## Development Notes + +Launching Qt Designer + +```bash +pyqt5-tools designer +``` + +Launching Dual Pane Windows Terminal + +```bash +# Command Prompt wt -d . -p "Command Prompt" ; sp -d . -p "Command Prompt" +# Powershell +start wt -Arg "-d . -p `"Powershell`" ; sp -d . -p `"Powershell`"" ``` - -Then in each pane, run the client: -```bash -python launch.py c -``` -and the server: -```bash -python launch.py s -``` - -## To-do List - -Expand to-do list