Tools used to do stuff
This project uses a standard GNU Autotools build system. 'nough said.
sudo apt install build-essential autoconf automake
On mac use brew and package names are autoconf, automake, and jq
Download the two files in cygwin-install
https://github.com/puterstructions/tools/tree/master/cygwin-install
Run (double-click works) the install.bat file.
Add C:\cygwin64\bin to your PATH. Now the rest of the setup below should now work from your Cygwin terminal.
There are a lot of opinions on building with autotools, these are Sandman's. Feel free to ignore them and build the project using your own autotools practices.
From the project root
autoreconf --install
mkdir build
cd build
../configure --prefix=$PWD
autoreconf will generate all the scripts needed to configure the build. The --prefix will cause all the Makefiles to use the specified absolute path for installation--handy for testing the build.
Remember to ALWAYS run make ... from the same directory you ran ./configure
Once you have the build configured, run it is just the normal make stuff, e.g. since we configured with --prefix we can install in our build tree for testing
make install
There are a number of ways to distribute projects using Autotools, it's one of the perks. The easiest is using dist
make dist
You should see some archives in the project root, usually a tarball and a zip. This can be changed in configure.ac. Before you really release you should test the distribution. Again, Autotools makes this really easy.
make distcheck
This will ensure that your distribution passes all the standard checks. For example, in this project Autotools is configured to ensure all executables provide --help and --version.
NOTE: currently make distcheck may fail due to an issue with shflags
There are lots of ways to build a Docker image from an Autotools build. For convenience you can use the distbin script in this project
$ distbin
$ Docker build -t puterstructions-tools .
A major part of our workflow involves documentation, which we call runbooks. You'll need to be able to create/use them. Follow these steps:
Get pip, if you don't have it
$ sudo easy_install pip
For Windows cygwin environments to get pip
easy_install-2.7 pip
sudo pip install --no-cache-dir -r ./lib/requirements.txt
Now view it in your browser at http://localhost:8000. You can also use the terminal to lauch it like so