aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorbozokopic <bozo.kopic@gmail.com>2017-04-24 16:44:11 +0200
committerbozokopic <bozo.kopic@gmail.com>2017-04-24 16:44:11 +0200
commitaa015cad8b69a55fbd5f171f786de11273b1a64f (patch)
tree1f7f5f966c5f7a541b033d40dabdc25807501808
parent333dfc65d327cd688aa74fd930d13e3e7a5014c0 (diff)
README update
-rw-r--r--README.rst23
1 files changed, 21 insertions, 2 deletions
diff --git a/README.rst b/README.rst
index c0b7955..5add90d 100644
--- a/README.rst
+++ b/README.rst
@@ -1,10 +1,10 @@
optcut
======
-`https://opcut.herokuapp.com/`_
+`https://opcut.herokuapp.com/`
`optcut` is cutting stock problem optimizer
-(`https://en.wikipedia.org/wiki/Cutting_stock_problem`_) utilizing multiple
+(`https://en.wikipedia.org/wiki/Cutting_stock_problem`) utilizing multiple
panels and guillotine cuts (end-to-end cuts). This project includes multiple
back-end optimizer implementations and single-page web application front-end.
@@ -24,6 +24,25 @@ Development requirements
* yarn
+Build
+-----
+
+Build tool used for `opcut` is pydoit (`http://pydoit.org/`). It can be
+installed together with other python dependencies by running::
+
+ $ pip install -r requirements.pip.txt
+
+For listing available doit tasks, use::
+
+ $ doit list
+
+Default task::
+
+ $ doit
+
+creates `dist` folder containing `opcut` distribution.
+
+
TODO
----