From 86d8a5043770271fb0e408360bc46c2648746faf Mon Sep 17 00:00:00 2001 From: Suraj Pai Date: Fri, 20 Oct 2017 03:59:56 +0530 Subject: [PATCH] Updated README for new makefile #195 --- README.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f68a807b..a4a8f5b7 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,11 @@ See [examples/README](examples/README) for explanation on how to write a driver ## Requirements -To install the dependencies, run: +Installing dependencies using Makefile, + + make init + +Alternatively, To install the dependencies, run: pipenv install @@ -40,7 +44,12 @@ You can also install packages from your distribution. ## Running the game -Start the server on some machine: +Run the game using Makefile with the command, + + make server + + +Alternatively, Start the server on some machine: ./rose-server @@ -48,6 +57,10 @@ Open a browser at http://\:8880 to view and control the game. Start up to 2 clients: + make client + +Or alternatively, + ./rose-client mydriver.py For driver modules, see the examples directory. @@ -57,6 +70,9 @@ Command line interface ---------------------- You can control the game from the command line using the rose-admin tool. + + make admin + To start a race, use rose-admin tool on any machine: @@ -81,6 +97,10 @@ would change game rate to 10 frames per second: Before submitting patches, please run the tests: + make test + +Or alternatively, + pytest Creating coverage report in html format: