summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKyle Gunger <corechg@gmail.com>2020-04-17 12:52:09 -0400
committerKyle Gunger <corechg@gmail.com>2020-04-17 12:52:20 -0400
commitf27f142d1a7d37919a591ec3a873c71bab26ae81 (patch)
tree3cfb9989faf7f9823c6941dc63ec2a7dfc683b80 /README.md
[Initial] Verison 0.0.1
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8627e71
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# Sparkt
+Wires and stuff!
+Requires the [TransitAPI](https://github.com/CoreChg/TransitAPI).
+
+## Building
+1. Clone the repo
+2. Create a folder "libs"
+3. Download the required APIs and put them in libs
+4. Initialize gradle
+5. Gradle build
+
+## License
+This mod is available under the MIT license.