Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updated README for new makefile #195 #197

Closed
wants to merge 1 commit into from
Closed

Updated README for new makefile #195 #197

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 22 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -40,14 +44,23 @@ 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

Open a browser at http://\<server-address\>:8880 to view and control the game.

Start up to 2 clients:

make client
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately this does not work - the client needs a driver module argument.

I think we need to remove the makefile instead of updating the readme. It helps only with the initial setup, and using a makefile breaks compatibility on windows.


Or alternatively,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Having alternatives for everything is confusing. We should have one simple way that works for everyone.


./rose-client mydriver.py

For driver modules, see the examples directory.
Expand All @@ -57,6 +70,9 @@ Command line interface
----------------------

You can control the game from the command line using the rose-admin tool.

make admin
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same issue, a server address is needed, and then a command (e.g. start) with optional arguments (e.g set-rate 5)



To start a race, use rose-admin tool on any machine:

Expand All @@ -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:
Expand Down