From 35dd062e6061a81ceddc6fc648db44accfadeb1b Mon Sep 17 00:00:00 2001 From: "Stefan E. Funk" <funk@sub.uni-goettingen.de> Date: Mon, 20 Jul 2020 16:05:19 +0200 Subject: [PATCH] Correct local build doc --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 390c61e..b71bcd7 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,21 @@ Guidelines and references for software development in RDD -To compile in markdown, use +To create main markdown document and compile to PDF, use ```bash -pandoc --template=rdd.latex rdd-technical-reference.md -o rdd-technical-reference.pdf +cat technical-reference-main.txt | while read LINE; do cat $LINE >> technical-reference.md ; done +pandoc --template=rdd.latex technical-reference.md -o technical-reference.pdf ``` Inspired by the [EURISE Network Technical Reference](https://github.com/eurise-network/technical-reference). + +## Sources and PDF + +The sources and the PDF of this reference are available continuously with every release here: https://gitlab.gwdg.de/fe/technical-reference/-/releases + + ## Contributing Commits have to be made following a certain convention that is defined by the @@ -25,8 +32,7 @@ npm install You can now run a commit using commitizen with `git cz`. -To run commitizen on `git commit` rather than on `git cz`, update or create `.git/hooks/prepare-commit-msg` with the -following code: +To run commitizen on `git commit` rather than on `git cz`, update or create `.git/hooks/prepare-commit-msg` with the following code: ```bash #!/bin/bash @@ -41,3 +47,5 @@ that should reflect the extent of your contribution: These commit types trigger a `patch` or `minor` release when merged into the `master` branch. To trigger a `major` release, please consult your fellow contributors and mark one of your commits with a `BREAKING CHANGE`. + +The `master` branch is protected for direct commits, so please use feature branches and do merge them into `master`. -- GitLab