From 6d60ea91c04e80e591aebee81907adbb5efa4de3 Mon Sep 17 00:00:00 2001
From: a dinosaur <nick@a-dinosaur.com>
Date: Fri, 27 Sep 2019 16:16:50 +1000
Subject: [PATCH] update README.md

---
 neotools/README.md | 42 ++++++++++++++++++++++++++++--------------
 1 file changed, 28 insertions(+), 14 deletions(-)

diff --git a/neotools/README.md b/neotools/README.md
index 5c17ccf..941c4e5 100644
--- a/neotools/README.md
+++ b/neotools/README.md
@@ -1,32 +1,46 @@
 Neo-Geo VGM tools
------------------
+=================
 
 A hodge-podge of tools for working on NG VGM files,
 these files are provided in the hope that they may be useful to someone.
 
-Makefiles have currently not been tested but shouldn't be hard to get working.
-Windows binaries are available under the Releases tab.
-
 Included tools (sources included).
- - **adpcm.exe**:
+ - **adpcm**:
     ADPCM Type-A to WAV converter.
- - **adpcmb.exe**:
+ - **adpcmb**:
     ADPCM Type-B encoding tool that also does decoding to WAV.
- - **neoadpcmextract.exe**:
+ - **neoadpcmextract**:
     Scans a .vgm and dumps all ADPCM type A&B data to raw .pcm files.
- - **autoextract.bat**:
-    Convenience batch script that uses the above tools to dump all samples to WAVs.
+ - **autoextract**:
+    Convenience shell/batch script that uses the above tools to dump all samples to WAVs.
+
+Building
+--------
+Linux:
+```shell script
+make -f adpcm.Makefile
+make -f adpcmb.Makefile
+make -f neoadpcmextract.Makefile
+```
+
+Windows:
+- The updated Makefiles haven't been tested on Windows yet.
+- Working Windows binaries are available from the [Releases](https://github.com/ScrelliCopter/VGM-Tools/releases) tab.
 
 How to use
 ----------
-Copy your .vgz into this directory, drag it onto autoextract.bat,
-the script will create a directory of the same name and dump all the converted samples there.
+Linux:
+ - Run `./autoextract.sh` from this directory with a path to your .vgm or .vgz,
+   a directory for the song will be created containing wav samples.
+
+Windows:
+ - You will need gzip.exe (provided with the aforementioned release).
+ - Copy your .vgm or .vgz into this directory, drag it onto autoextract.bat,
+   the script will create a directory of the same name and dump all the converted samples there.
 
 That's all there is to it.
 
 TODO
 ----
 
- - Replace the batch script with something less shite (and actually cross-platform).
- - Write a makefile for neoadpcmextract.
- - Make this stuff build on Linux.
+ - Unify all tools into one & obsolete the crappy glue scripts.