initial commit of the technical specification document

README.md

@@ -1,2 +1,20 @@
-# actus-techspecs
-The ACTUS technical specifications
+# ACTUS Technical Specification Document
+
+[![License: CC BY-SA 4.0](https://img.shields.io/badge/License-CC%20BY--SA%204.0-lightgrey.svg)](https://creativecommons.org/licenses/by-sa/4.0/)
+
+The ACTUS Technical Specification Document provides a formal specification of the ACTUS standard for the algorithmic representation of financial contracts.
+
+It comes as a single ``latex`` file ``actus-techspecs.tex``. The latest version is generally available as a PDF at https://actusfrf.org/actus-techspecs.pdf.
+
+The ACTUS Technical Specification Document is freely available and licensed under Creative Commons Attribution Share-Alike (CC-BY-SA) version 4.0.
+
+## How to build
+
+The ACTUS Technical Specification Document can be built as a PDF as follows:
+
+```
+git clone https://github.com/actusfrf/actus-techspecs.git
+cd actus-techspecs
+./build.sh
+```
+Building will create a (number of) config-file(s) used for compiling the ``latex`` file and a PDF version of the ACTUS Technical Specifications Document. Standard `pdflatex` tools like http://latex.informatik.uni-halle.de/latex-online/latex.php can be used for compiling/preview once the White Paper is built.

bibliography.bib

@@ -0,0 +1 @@
+% repository of tex-bib references

build.sh

@@ -0,0 +1,37 @@
+#!/usr/bin/env bash
+
+##
+## Usage: build.sh
+##
+## Note: no arguments to the build script currently in use
+##
+
+
+set -e
+
+rm -rf build_options.tex
+
+if [ -d ".git" ]; then
+
+TAG=`git describe` || true
+SHA=`git rev-parse --short --verify HEAD`
+DATE=`git show -s --format="%cd" --date=short HEAD`
+REV="$TAG-$SHA-$DATE"
+echo "\def\VersionNumber{$REV}" >> build_options.tex
+
+fi
+
+
+if grep '=========' actus-techspecs.tex
+then
+  echo "merge conflict?"
+  exit 1
+fi
+
+mkdir -p build
+pdflatex -output-directory=build -interaction=errorstopmode -halt-on-error actus-techspecs.tex && \
+bibtex build/actus-techspecs && \
+pdflatex -output-directory=build -interaction=errorstopmode -halt-on-error actus-techspecs.tex && \
+pdflatex -output-directory=build -interaction=errorstopmode -halt-on-error actus-techspecs.tex && \
+pdflatex -output-directory=build -interaction=errorstopmode -halt-on-error actus-techspecs.tex && \
+rm -rf build_options.tex