Skip to content

Commit

Permalink
Add explanations of how to make bakefile distribution.
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
vadz committed Jul 28, 2014
1 parent 91312d5 commit aea9afb
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 4 deletions.
4 changes: 0 additions & 4 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -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.
33 changes: 33 additions & 0 deletions distrib/README
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit aea9afb

Please sign in to comment.