Skip to content
Snippets Groups Projects
Commit e6563a41 authored by jbierma's avatar jbierma
Browse files

Merge branch 'feature/fu-readme' into 'master'

Correct local build doc

See merge request !31
parents bfb87824 35dd062e
No related branches found
No related tags found
1 merge request!31Correct local build doc
Pipeline #145556 passed with warnings
...@@ -2,14 +2,21 @@ ...@@ -2,14 +2,21 @@
Guidelines and references for software development in RDD Guidelines and references for software development in RDD
To compile in markdown, use To create main markdown document and compile to PDF, use
```bash ```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). 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 ## Contributing
Commits have to be made following a certain convention that is defined by the Commits have to be made following a certain convention that is defined by the
...@@ -25,8 +32,7 @@ npm install ...@@ -25,8 +32,7 @@ npm install
You can now run a commit using commitizen with `git cz`. 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 To run commitizen on `git commit` rather than on `git cz`, update or create `.git/hooks/prepare-commit-msg` with the following code:
following code:
```bash ```bash
#!/bin/bash #!/bin/bash
...@@ -41,3 +47,5 @@ that should reflect the extent of your contribution: ...@@ -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. 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`. 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`.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment