nlbdev/pipeline repository overview

⁠pipeline

⁠Code

This is a convenience "super" Pipeline project that aggregates all sub-projects and 3rd-party libraries.

This makes branching, building, and releasing of several sub-projects at once easier.

The aggregating and the backporting of changes to the individual projects is done using a tool called git-subrepo⁠. The idea is that all the git magic will be done by the owners, and that committers can just treat this repository as a regular one. There is a rule though that committers need to follow because of some limitations of git-subrepo:

• Pull requests may not contain merge commits. In order to keep things structured, make one pull request per distinct feature.

Committers are of course also free to make pull requests to the individual repositories, or do other advanced things such as switching a certain sub-repository to an existing branch. Advanced git knowledge is required in these cases. Ask for help if needed.

The tree below shows the structure of the project:

• assembly⁠
• cli⁠
• clientlib-java⁠
• framework⁠
• gui⁠
• it⁠
• libs
  • braille-css⁠
  • braille-utils
    • braille-utils.api⁠
    • braille-utils.impl⁠
    • braille-utils.pef-tools⁠
  • dotify
    • dotify.api⁠
    • dotify.common⁠
    • dotify.formatter.impl⁠
    • dotify.hyphenator.impl⁠
    • dotify.text.impl⁠
    • dotify.task-api⁠
    • dotify.task.impl⁠
    • dotify.task-runner⁠
    • dotify.translator.impl⁠
  • jstyleparser⁠
  • osgi-libs⁠
• modules
  • audio⁠
  • braille⁠
  • common⁠
  • nlp⁠
  • scripts⁠
  • scripts-utils⁠
  • tts⁠
• updater
  • cli⁠
  • gui⁠
• utils
  • build-utils⁠
  • xprocspec⁠
  • xproc-maven-plugin⁠
  • xspec-maven-plugin⁠
• webui⁠

⁠Building on CentOS/Redhat

• Install pcregrep (if not already installed): yum install pcre-tools or yum install pcre
• Install libxml (libxml needs to be at least version 20900, if already installed check version with xmllint --version):
• wget ftp://xmlsoft.org/libxml2/libxml2-2.9.0-1.src.prm
• rpmbuild --rebuild libxml2-2.9.0-1.src.rpm
• rpm -i --force /path/to/rpm/libxml2-2.9.0-1.rpm
• Run make: make dist-rpm

⁠Issues

This is also a common issue tracker for the Pipeline. Use the individual issue trackers of the sub-projects listed above for issues that clearly belong to a specific sub-project. Before creating a new issue, please first check the existing open issues⁠.

⁠Website

The gh-pages branch contains the source of the Pipeline website⁠.