add markdown README and screenshot

mrirecon · Jan 29, 2018 · 187c48c · 187c48c
1 parent 800b1d9
commit 187c48c
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,30 @@
+
+
+Small image viewer for multi-dimensional files. Compiles
+on Linux and Mac OS X. It needs some libraries from
+the Berkeley Advanced Reconstruction Toolbox (BART).
+
+https://mrirecon.github.io/bart/
+
+![viewer](viewer.png)
+
+
+Installation:
+
+Requires BART up to commit e4df99aa75e0344931ba2e76d9ae052b02da498f
+
+Mac OS X:
+
+sudo port install pkgconfig
+sudo port install gtk3
+sudo port install adwaita-icon-theme
+
+Linux:
+sudo apt-get install libgtk-3-dev
+
+
+
+Compile with make after setting the TOOLBOX_PATH
+environment variable.
+
+
diff --git a/viewer.png b/viewer.png