update Readme

JMHOO · Apr 30, 2017 · b77e898 · b77e898
1 parent 98fc944
commit b77e898
Showing 1 changed file with 24 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,24 @@
-# BiocImageBuilder
+# Bioconductor docker image builder
+
+## Requirements
+- python 3.5
+- PyQt5
+- docker-py >= 2.0.0
+- Docker engine >= 1.18.0
+
+## Install requirements
+- PyQt5
+  brew install pyqt5
+
+- docker-py
+  pip3 install docker
+
+## How to run
+- Command line
+  python3 BiocImageBuilderMain.py
+
+- macOs precompiled package
+  download docker-image-builder-app-macOS.zip from Release tab
+
+  If you encountered 'Docker Credential' error during the building, please follow:
+  https://github.com/docker/docker-credential-helpers