Installation

Table of contents:

Button consists of two main components:

  1. button: The build system itself.
  2. button-lua: The build description generator from Lua scripts.

System Requirements

Supported platforms:

  • Linux

Unsupported platforms:

  • OS X
  • Windows

Supported for OS X and Windows will be coming in the future.

Installation Packages

Installation packages are rather sparse at the moment. If your distribution is not supported below, please see the Compiling From Source section. If you decide to create a package for your distribution, a pull request adding it to this section would be very appreciated.

Arch Linux

Install button from the Arch User Repository (AUR).

Compiling From Source

Installing Dependencies

To build, you’ll need Git, DMD (the D compiler), and DUB (the D package manager).

On Arch Linux, these can be installed with:

$ sudo pacman -Sy git dlang dub

Building button

  1. Get the source:

    $ git clone https://github.com/jasonwhite/button.git && cd button

  2. Build it:

    $ dub build --build=release

There should now be a button executable in the current directory. Copy it to a directory that is in your $PATH and run it to make sure it is working:

$ button help

Building button-lua

button-lua is written in C++ and thus the build process is a little different.

  1. Get the source:

    $ git clone --recursive https://github.com/jasonwhite/button-lua.git && cd button-lua

  2. Build it:

    $ make

There should now be a button-lua executable in the current directory. Copy it to a directory that is in your $PATH and run it to make sure it is working:

$ button-lua
Usage: button-lua <script> [-o output] [args...]

Optional: Building button-make

Experimental.

This is only needed if you have Makefiles you want to build and/or visualize.

button-make is a modified version of GNU Make and thus the build process is the same as building make:

  1. Get the source:

    $ git clone https://github.com/jasonwhite/button-make.git && cd button-make

  2. Build it:

    $ autoreconf -i
$ ./configure --prefix=$(pwd)/install --program-prefix=button-
$ make update
$ make && make install

There should now be an install directory in the current directory. Copy install/bin/button-make to a directory that is in your $PATH and run it to make sure it is working:

$ button-make --version

If you run into problems, see GNU Make’s own README.git for more information on building from source. If that fails you, please submit an issue.