Skip to content

Commit 620574a

Browse files
committed
docs(readme): add submodule instructions
1 parent ae72215 commit 620574a

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
# <a target="_blank" rel="noopener noreferrer" href="https://www.software-challenge.de"><img width="64" src="https://github.com/raw/CAU-Kiel-Tech-Inf/socha-gui/master/assets/build-resources/icon.png" alt="Software-Challenge Germany logo"></a> GUI für die Software-Challenge Germany [![Build Status](https://travis-ci.com/CAU-Kiel-Tech-Inf/gui.svg?branch=master)](https://travis-ci.com/CAU-Kiel-Tech-Inf/gui)
22

33
## Getting Started
4-
- repository klonen
5-
- das [Server-Projekt](https://github.com/CAU-Kiel-Tech-Inf/server) muss sich aktuell im selben Überverzeichnis wie dieses Projekt befinden (`../server`) und die Jar-Artefakte dort müssen gebaut sein (inklusive plugin)
4+
- repository mit submodulen klonen:
5+
```sh
6+
git clone https://github.com/CAU-Kiel-Tech-Inf/gui.git --recurse-submodules --shallow-submodules
7+
```
68
- Java 11 wird benötigt (ggf. `org.gradle.java.home=/path/to/jdk` in `gradle.properties` setzen)
79
- `./gradlew run` ausführen
810

911
## Kollaboration
1012

11-
Unsere Commit-Messages folgen dem Muster `type(scope): summary` (siehe [Karma Runner Konvention](http://karma-runner.github.io/latest/dev/git-commit-msg.html)), wobei die verfügbaren Scopes in [.dev/scopes.txt](.dev/scopes.txt) definiert werden. Bitte führe nach dem Klonen des Repository's einmal Folgendes im Terminal aus, damit die entsprechenden Git-Hooks aktiv werden:
13+
Unsere Commit-Messages folgen dem Muster `type(scope): summary` (siehe [Karma Runner Konvention](http://karma-runner.github.io/latest/dev/git-commit-msg.html)), wobei die verfügbaren Scopes in [.dev/scopes.txt](.dev/scopes.txt) definiert werden. Bitte führe nach dem Klonen des Repository's Folgendes im Terminal aus, damit die entsprechenden Git-Hooks aktiv werden:
1214

1315
git config core.hooksPath .dev/githooks
1416

0 commit comments

Comments
 (0)