diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..29e5a5b --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +#  + +SSHTron is a multiplayer lightcycle game that runs through SSH. Just run the +command below and you'll be playing in seconds: + + $ ssh sshtron.zachlatta.com + +## Running Your Own Copy + +Clone the project and `cd` into its directory. These instructions assume that +you have your `GOPATH` setup correctly. + +```sh +# Create an RSA public/private keypair in the current directory for the server +# to use. Don't give it a passphrase. +$ ssh-keygen -t rsa -f id_rsa + +# Download dependencies and compile the project +$ go get && go build + +# Run it! You can set PORT to customize the HTTP port it serves on and SSH_PORT +# to customize the SSH port it serves on. +$ ./sshtron +``` + +## License + +SSHTron is licensed under the MIT License. See the full license text in +[`LICENSE`](LICENSE). |