Improve README
This commit is contained in:
2
Makefile
2
Makefile
@@ -25,7 +25,7 @@ publish-docker: build-docker ## Publish docker image of application to Github
|
|||||||
run-docker: ## Build and Run all docker services
|
run-docker: ## Build and Run all docker services
|
||||||
docker-compose up -d --build
|
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)
|
git diff --quiet --exit-code || (echo "The git is DIRTY !!! You cannot publish this crap!" && exit 1)
|
||||||
gradlew publish
|
gradlew publish
|
||||||
|
|
||||||
|
|||||||
25
README.md
25
README.md
@@ -1,6 +1,7 @@
|
|||||||
# Installation
|
# DC Project
|
||||||
|
|
||||||
## On windows
|
## Installation of Development environment
|
||||||
|
### On windows
|
||||||
1. Install git
|
1. Install git
|
||||||
- Download and install: https://git-scm.com/download/win
|
- Download and install: https://git-scm.com/download/win
|
||||||
2. Install Make
|
2. Install Make
|
||||||
@@ -9,14 +10,26 @@
|
|||||||
- Extract zip.
|
- Extract zip.
|
||||||
- Copy the contents to your `Git\mingw64\` merging the folders, but **do NOT overwrite/replace** any existing files.
|
- Copy the contents to your `Git\mingw64\` merging the folders, but **do NOT overwrite/replace** any existing files.
|
||||||
|
|
||||||
## Run dockers
|
### Run dockers
|
||||||
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ make run-docker
|
$ make run-docker
|
||||||
```
|
```
|
||||||
|
|
||||||
## Add fixtures
|
### Add fixtures
|
||||||
```bash
|
```bash
|
||||||
$ make fixtures
|
$ 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
|
||||||
|
```
|
||||||
Reference in New Issue
Block a user