aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorZach Latta <zach@zachlatta.com>2016-03-06 12:40:28 -0500
committerZach Latta <zach@zachlatta.com>2016-03-06 12:40:28 -0500
commitfbddbe9d371b221139e4fa043884a28d24737efb (patch)
tree64acd5ad21c17ff1c6cad0eb0b7910afed6382d7
parente3726ed226e2ac4f7e93a57c75308b6e1c06f476 (diff)
downloadsshtron-fbddbe9d371b221139e4fa043884a28d24737efb.tar.gz
Add README and LICENSE
-rw-r--r--LICENSE19
-rw-r--r--README.md29
2 files changed, 48 insertions, 0 deletions
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..3348374
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,19 @@
+Copyright (c) 2016 Max Wofford & Zach Latta
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE. \ No newline at end of file
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](https://cdn.rawgit.com/zachlatta/sshtron/master/logo.svg)
+
+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).
Un proyecto texto-plano.xyz