From 2e344a01bc83e27135d4bc665822ae54a8a267f8 Mon Sep 17 00:00:00 2001 From: Freeyorp Date: Mon, 13 May 2013 00:38:39 +1200 Subject: Update documentation --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 03bcf6f..562099c 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,17 @@ manavis ======= -This program is designed to parse and visualise combat logs generated by the tmwAthena server. +Manavis parses and visualises 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. +Manavis can operate in two modes, offline and online. + +To run in offline mode, place the public/ folder in a location served by a web server, or run python -m SimpleHTTPServer from it, and connect to localhost:8000. +While offline, you can still analyse everything as you would normally. + +To run in online mode, run node index.js from the project root, and connect to localhost:3000. +In online mode, active filters are broadcast to other users, similar to multiplayer notepad or etherpad. +Currently, all changes are applied from everyone in online mode. +This can be inconvenient, and should be changed in the near future. +You can still operate offline by unselecting the checkbox at the loading screen. Significant amounts of processing in javascript are required. It is recommended you use recent versions of a browser such as chromium. -- cgit v1.2.3-60-g2f50