update README

hurryhuang1007 · Sep 2, 2019 · 85b82df · 85b82df
1 parent e8e4bd9
commit 85b82df
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,26 @@
+# Xslide
+
+An application that can quickly view large images like .tif, .svs, .bif, .hdpi, .vms and .mrxs file(s).
+
+## Screenshot
+
+![init](./screenshot/init.jpg)
+![viewer-1](./screenshot/viewer-1.jpg)
+![viewer-2](./screenshot/viewer-2.jpg)
+![viewer-3](./screenshot/viewer-3.jpg)
+
+## Credits
+
+Xslide would not exist without them:
+
+[libvips](https://libvips.github.io/libvips/)
+- A fast image processing library with low memory needs.
+
+[electron](https://electronjs.org/)
+- Build cross platform desktop apps with JavaScript, HTML, and CSS
+
+## TODO
+
+[] adapt MacOS
+
+[] adapt Linux
diff --git a/screenshot/init.jpg b/screenshot/init.jpg
diff --git a/screenshot/viewer-1.jpg b/screenshot/viewer-1.jpg
diff --git a/screenshot/viewer-2.jpg b/screenshot/viewer-2.jpg
diff --git a/screenshot/viewer-3.jpg b/screenshot/viewer-3.jpg