iss #34: deb build instructions & shell script

maizy · Oct 3, 2014 · a981448 · a981448
1 parent 0b4c20f
commit a981448
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 0 deletions.
diff --git a/build_deb.sh b/build_deb.sh
@@ -0,0 +1,13 @@
+#!/bin/bash
+BIN=`which sbt`
+SCRIPT_PATH=$(cd ${0%/*} && echo $PWD/${0##*/})
+ROOT=`dirname "${SCRIPT_PATH}"`
+
+if [ -z "${BIN}" ]; then
+    echo "sbt not found in ${PATH}"
+    exit 1
+fi
+
+cd "${ROOT}"
+
+"${BIN}" 'debian:packageBin'
diff --git a/docs/BuildDeb.md b/docs/BuildDeb.md
@@ -0,0 +1,25 @@
+# Build .deb
+
+## Prerequirements
+
+* keemun checkout (via `git clone ...` or [tarball](https://github.com/maizy/zaglushka/archive/master.tar.gz))
+* sbt([deb package available](http://www.scala-sbt.org/0.13/tutorial/Installing-sbt-on-Linux.html))
+* deb packages `dpkg`, `fakeroot`
+
+## How to
+
+```bash
+# checkout keemun
+cd keemun/
+./build_dev.sh
+dpkg -i target/keemun_X.Y.Z-SNAPSHOT_all.deb
+```
+where `X.Y.Z` - current project version
+
+## Supported OS
+
+* Ubuntu 12.04
+ * Build tested on clean Ubuntu Server 12.04.5
+* *TODO*: Ubuntu 14.04
+
+Other .deb based OS also may work, but not tested.
diff --git a/docs/README.md b/docs/README.md
@@ -5,3 +5,8 @@
 
 * [Backends API](Api.md)
 * [Models](Models.md)
+
+<a name="deploy"/>
+## Deploy
+
+* [Build .deb](BuildDeb.md)