Improve README

This commit is contained in:
2020-05-14 13:46:44 +02:00
parent 159b9de19a
commit ac852baaf6
2 changed files with 20 additions and 7 deletions

View File

@@ -25,7 +25,7 @@ publish-docker: build-docker ## Publish docker image of application to Github
run-docker: ## Build and Run all docker services
docker-compose up -d --build
publish-jar: ## Publish JAR file to Github
publish-maven: ## Publish JAR file to Github
git diff --quiet --exit-code || (echo "The git is DIRTY !!! You cannot publish this crap!" && exit 1)
gradlew publish

View File

@@ -1,6 +1,7 @@
# Installation
# DC Project
## On windows
## Installation of Development environment
### On windows
1. Install git
- Download and install: https://git-scm.com/download/win
2. Install Make
@@ -9,14 +10,26 @@
- Extract zip.
- Copy the contents to your `Git\mingw64\` merging the folders, but **do NOT overwrite/replace** any existing files.
## Run dockers
### Run dockers
```bash
$ make run-docker
```
## Add fixtures
### Add fixtures
```bash
$ make fixtures
```
## Publish package
1. Got to [https://github.com](https://github.com/settings/tokens/new) and create a new token with packages scopes
2. Create a file `GH_TOKEN.txt` and put it the github token
### Maven
```bash
$ make publish-maven
```
### Docker
```bash
$ make publish-docker
```