summaryrefslogtreecommitdiffstats
path: root/ship/README.markdown
blob: 01a63bd657ad9fff7dc46821ea0abd3c2462b08b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# ship - shellscript installation processor

  This utility is used to build modular shell scripts using recursive macro
  expansion.

## Quickstart Guide

    BUILD_PATH=libs ./build compile INPUTFILE OUTPUTFILE

  If this doesen make science to you, then prepend `debug=true` to get all
  the intermediate files printed to stdout.

## Make Interface

  Put libraries into `lib`.
  Put executables into `src`.

  Build all executables from `src` into `tmp` with

    make [all]

  Build all executables from `src` into `tmp` and `//bin` with

    make install

  Undo `make [all]` with

    make clean

  Undo `make install` with

    make distclean