From 6e5d1781a6cfe55a5da96fefd819994d2c7707f4 Mon Sep 17 00:00:00 2001 From: Alec Date: Wed, 23 Feb 2022 22:05:59 -0500 Subject: [PATCH] Update README.md --- README.md | 20 +++++++------------- 1 file changed, 7 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 985ac80..9e4c5b5 100644 --- a/README.md +++ b/README.md @@ -3,15 +3,13 @@

Find the latest deployment here: https://playwerewolf.uk.r.appspot.com/. -I value your feedback. An application to run games of Werewolf (Mafia) -smoothly when you don't have a deck, or when you and your friends are together virtually. Inspired by my time playing -Ultimate Werewolf and by -2020's quarantine. The app is free to use and anonymous. +smoothly when you don't have a deck, or when you and your friends are together virtually. Basically, a host builds a game and deals a role to everyone's device, and then the app keeps track of the game state (timer, player statuses, etc). + +Inspired by my time playing Ultimate Werewolf and by +2020's quarantine. The app is free to use, anonymous, and fully open-source under the MIT license. After a long hiatus I've rewritten a lot of the code and think this version works a lot better. This was (and still is) fundamentally a learning project, so feedback or assistance is appreciated. -After a long hiatus from maintaining the application, I have come back and undertaken a large-scale redesign, rewriting -most of the code and producing a result that I believe is more stable and has much more sensible client-server interaction.

@@ -35,11 +33,7 @@ The application prioritizes responsiveness. A key scenario would be when a group ## Tech Stack This is a Node.js application. It is written purely using JavaScript/HTML/CSS. The main dependencies are -Express.js and Socket.io. It is fully open-source -and under the MIT license. This was (and still is) fundamentally a learning project, and thus I welcome collaboration -and feedback of any kind. - -All pixel art is my own, for better or for worse. +Express.js and Socket.io. ## Contributing and Developers' Guide @@ -62,10 +56,10 @@ This command uses nodemon to listen for changes to **server-side code** (Node.js modules) and automatically restart the server. If you do not want this, run instead `npm run start:dev:no-hot-reload` or `npm run start:dev:windows:no-hot-reload`. -If you are developing as well, in a separate terminal, execute `npm run build:dev`. This uses +If you are making changes to client-side javascript, in a separate terminal, execute `npm run build:dev`. This uses Webpack to bundle javascript from the `client/src` directory and place it in the `client/dist` directory, which is ignored by Git. This command uses the `--watch` flag, which means the process will continue -to run in this terminal, watching for changes to JavaScript within the `client/src` directory and re-bundling automatically. You +to run in this terminal, watching for changes within the `client/src` directory and re-bundling automatically. You definitely want this if making frequent JavaScript changes to client-side source code. Any other changes, such as to HTML or CSS files, are not bundled, and thus your changes will be picked up simply by refreshing the browser.