summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..03bcf6f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,8 @@
+manavis
+=======
+
+This program is designed to parse and visualise combat logs generated by the tmwAthena server.
+
+To run, place this project in a location served by a web server, or run python -m SimpleHTTPServer from the project root and connect to localhost:8000.
+
+Significant amounts of processing in javascript are required. It is recommended you use recent versions of a browser such as chromium.