From aa015cad8b69a55fbd5f171f786de11273b1a64f Mon Sep 17 00:00:00 2001 From: bozokopic Date: Mon, 24 Apr 2017 16:44:11 +0200 Subject: README update --- README.rst | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) (limited to 'README.rst') 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 ---- -- cgit v1.2.3-70-g09d2