summaryrefslogtreecommitdiff
path: root/README
blob: ee915fca13cfa247be6d6760544f02d4f6e53b4c (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
Shared build-system files for (some) parts of Taler.

A repository using these build-system files should be structured as follows:

<my-repository.git>
- bootstrap (copied/adjusted from bootstrap.template)
- build-system (directory containing build system "stuff")
--| configure.py (copied/adjusted from bootstrap.template)
--| taler-build-scripts (git submodule of taler-build-scripts)
--| Makefile

Makefile and configure.py can also be placed directly into the root of the
repository.  However, this might lead to errors when "make" can be invoked
before bootstrap and configure has been done.


directory structure:
--------------------

conf:
- contains mixed configuration data, mostly for linters and editors

sh:
- contains shell script code in reusable, importable pieces,
  usually one function per file and files named after their
  function.
  the sh/lib.sh folder contains library code.
  the sh/bin.sh folder contains executable scripts which can be
  used for various functions.
  Current caveat: the files all have to be included. shell independent
  detection of real pathnames is tricky.