Merge pull request #37 from chris-allan/releases-in-readme

Add more "release" style documentation to README

README.md

@@ -12,26 +12,44 @@ Requirements
 libblosc (https://github.com/Blosc/c-blosc) version 1.9.0 or later must be installed separately.
 The native libraries are not packaged with any relevant jars.  See also note in n5-zarr readme (https://github.com/saalfeldlab/n5-zarr/blob/0.0.2-beta/README.md)
 
-Usage
-=====
+ * Mac OSX: `brew install c-blosc`
+ * Ubuntu 18.04+: `apt-get install libblosc1`
+
+Installation
+============
+
+1. Download and unpack a release artifact:
+
+    https://github.com/glencoesoftware/raw2ometiff/releases
+
+Development Installation
+========================
+
+1. Clone the repository:
 
-Build with Gradle:
+    git clone [email protected]:glencoesoftware/raw2ometiff.git
 
-    gradle clean build
+2. Run the Gradle build as required, a list of available tasks can be found by running:
 
-Unpack the distribution:
+    ./gradlew tasks
 
-    cd build/distributions
-    unzip raw2ometiff-$VERSION.zip
-    cd raw2ometiff-$VERSION
+Eclipse Configuration
+=====================
+
+1. Run the Gradle Eclipse task:
+
+    ./gradlew eclipse
+
+Usage
+=====
 
 Run the conversion (Bio-Formats 6.x):
 
-    bin/raw2ometiff tile_directory pyramid.ome.tiff
+    raw2ometiff tile_directory pyramid.ome.tiff
 
 or generate a 5.9.x-compatible pyramid:
 
-    bin/raw2ometiff tile_directory pyramid.tiff --legacy
+    raw2ometiff tile_directory pyramid.tiff --legacy
 
 The input tile directory must contain a full pyramid in a Zarr or N5 container.
 
@@ -45,3 +63,9 @@ Areas to improve
 * Compatibility with both iSyntax and .mrxs
     - map JSON metadata to OME-XML (magnification etc.)
     - fix tile sizes used when downsampling (TIFF input only)
+
+License
+=======
+
+The converter is distributed under the terms of the GPL license.
+Please see `LICENSE.txt` for further details.