flexible development and application framework
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
ant
docs
src
tool
.gitignore
LICENSE
README.asciidoc
build.gradle
build.sh
gradlew
pom.xml
settings.gradle
skb-site-scripts.skb
skb-site.id

README.asciidoc

SKB Framework

a flexible, metadata driven application framework.

Table of Contents

Overview

The framework is written in bash and runs on most UNIX platforms that have bash version 4 installed. We have tested it on

  • Ubuntu 14/16/18

  • Debian 3

  • Raspian (on PI model B and B+)

  • Cygwin on Windows 7 and 10

  • Windows 10 WSL with Ubuntu 18 installed

  • Mac OS X

Requirements

to use

The program has a few mandatory external dependencies, listed below. All of them are part of a standard Linux system with GNU tools. On some system, a manual installation can be required. For instance, Raspian does not install bc by default. Mac OS might require special attention to install GNU tools, e.g. with brew.

  • bash version 4, since we are using associative arrays (hash maps) for internal configuration

  • GNU getopt, all CLI parsing is done using getopt from GNU

  • bc, for some calculations, mostly runtime

  • mktemp, for creating temporary files and directories

to build distributions

To build distribution packages (DEB, RPM, tarball):

  • gradle version 4, the build uses gradle, a gradlew is provided

to build all artifacts

Generating nicely formated text paragraphs and list requires:

  • gradle version 4, the build is done with gradle (gradlew is provided)

Not mandatory, but required to build all documentation artifacts are:

  • asciidoctor, to create HTML and man page from ADOC sources

  • asciidoctor-pdf, to create PDF from ADOC sources

To generate the site for the program requires:

  • Java JDK 8, since we are using Maven

  • Apache Maven, since the site is written as a Maven site