Skip to content
This repository was archived by the owner on Sep 19, 2021. It is now read-only.

README update with new cmdline arguments#40

Merged
vaage merged 3 commits intomasterfrom
update_readme
Apr 10, 2017
Merged

README update with new cmdline arguments#40
vaage merged 3 commits intomasterfrom
update_readme

Conversation

@crepricg
Copy link
Copy Markdown
Contributor

@crepricg crepricg commented Apr 10, 2017

Updates the launch instructions in the README.md file to include the cmd line arguments that are now needed.

Comment thread README.md
Make sure the client and server are using the same port number.
You must specify the following startup arguments for `run_server.sh:
+ `<team_id>` and `<team_secret>`: a numeric id for your team, and a secret
code, which are used to authenticate your server with the Relay server.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The secrete must be HEX (ie. a string of a-fA-F0-9)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The server takes any string as input, and unless one connects to the Relay the secret is never used. Plus Secret.parse() can handle non-hex characters, so any char out of range will be seen as 0, but I'll add the specs anyway :)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks. Secret.parse really should be changed to throw an IOException.

Comment thread README.md Outdated
`<team_secret>` when you launch the server in your local setup since it
will not connect to the Relay server.
You can specify any integer value for `<team_id>`, and a value expressed
in hexadecimal format (using numbers `0-9` or letters in the range `A-F`)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

NIT: Should this be 'or' or 'and'?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I think both work. I changed it to and.

@vaage vaage merged commit 182a1c9 into master Apr 10, 2017
@vaage vaage deleted the update_readme branch April 10, 2017 22:04
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants