added readme

README.md

@@ -0,0 +1,21 @@
+xivv updater
+============
+
+A tool for maintaining an updated copy of XIVVoices on a network share. Clients can mount the share directory created as C:\XIV\_Voices, or run XIVVoices.exe directly from the network share. Clients should be denied write permission to avoid clobbering the host data
+
+Usage
+-----
+`get_latest.sh [-J <parallel processes (default 5)>] [-L <download rate of each process (default 2M)>]`
+
+After update is complete, run share/XIVVoices.exe
+
+Automatic updating
+------------------
+
+WIP: `wine setup.exe` requires a DISPLAY. Probably need to set up Xvfb. The script can be run manually for now.
+
+This could be done with cron:
+
+`0 * * * * bash /path/to/get_latest.sh`
+
+or with systemd: TODO