From aea9afb1b791658a205713e3e64af4517916d8af Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Mon, 28 Jul 2014 22:49:30 +0200 Subject: [PATCH] Add explanations of how to make bakefile distribution. Also remove the mention of submodules from the main README, the only currently existing submodule (3rdparty/pyinstaller) is only needed for making bakefile distributions under Windows, not using it. --- README | 4 ---- distrib/README | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 33 insertions(+), 4 deletions(-) create mode 100644 distrib/README diff --git a/README b/README index df1efa38..ecd73ea8 100644 --- a/README +++ b/README @@ -48,10 +48,6 @@ the git repository: easy_install clint (for colorized output) -If you are using a git checkout, then you just need to checkout the submodules: - - git submodule init - git submodule update Once all tools are installed, you can build Bakefile by running `make`. This generates the parser from ANTLR grammar and build the HTML documentation. diff --git a/distrib/README b/distrib/README new file mode 100644 index 00000000..75de1e52 --- /dev/null +++ b/distrib/README @@ -0,0 +1,33 @@ +0. Before making a distribution +------------------------------- + +- Run "make test". +- Create a tag vX.Y.Z where "X.Y.Z" is the version. + + +1. Making Unix distribution +--------------------------- + +Run "make -C distrib distrib_unix", the output file will be +bakefile-X.Y.Z_beta-bin.tar.bz2. + + +2. Making Windows distribution +------------------------------ + +Ensure that you have pyinstaller submodule (which is only needed for making +Windows distributions) and do + + git submodule update --init 3rdparty/pyinstaller + +if necessary. + +Check that upx and zip are in PATH. + +Run "make -C distrib distrib_win", the output file be +bakefile-X.Y.Z_beta-win.zip + +Notice that at one time there was an effort to produce an MSI installer for +bakefile and its remains can be found in wix subdirectory, however the files +there are not maintained and bakefile currently is not distributed in this +form.