Update/readme

This commit is contained in:
Mika Wauben
2019-04-09 07:30:07 +00:00
parent 4b949db919
commit 222489a316
2 changed files with 23 additions and 25 deletions

View File

@@ -36,12 +36,12 @@ test:
- .gradle
# Code coverage badge
# code-coverage:
# stage: code-coverage
# script:
# - mvn -B clean verify
# after_script:
# - awk -F"," '{ instructions += $4 + $5; covered += $5 } END { print covered, "/", instructions, " instructions covered"; print 100*covered/instructions, "% instructrions covered" }' target/site/jacoco/jacoco.csv
# - awk -F"," '{ instructions += $6 + $7; covered += $7 } END { print covered, "/", instructions, " branches covered"; print 100*covered/instructions, "% branches covered" }' target/site/jacoco/jacoco.csv
# - echo \"$(cat target/site/jacoco/jacoco.csv)% covered\"
# coverage: '/(\d+.\d+) % +branches covered/'
#deploy:
# stage: code-coverage
# script:
# - gradle clean check
# after_script:
# - awk -F"," '{ instructions += $4 + $5; covered += $5 } END { print covered, "/", instructions, " instructions covered"; print 100*covered/instructions, "% instructrions covered" }' target/site/jacoco/jacoco.csv
# - awk -F"," '{ instructions += $6 + $7; covered += $7 } END { print covered, "/", instructions, " branches covered"; print 100*covered/instructions, "% branches covered" }' target/site/jacoco/jacoco.csv
# - echo \"$(cat target/site/jacoco/jacoco.csv)% covered\"
# coverage: '/(\d+.\d+) % +branches covered/'

View File

@@ -1,35 +1,33 @@
# Greenify
# Greenify
The easiest way to save CO2 and help the environment! Enter your activities and find out your carbon footprint.
![loginscreen](/uploads/beaa1efa87d77179600a34953b9b34c9/loginscreen.png)
![application](/uploads/6fdd73ce8c8b55d63f31dd36755ebafd/application.png)
## Badges
[![build status](https://gitlab.ewi.tudelft.nl/cse1105/2018-2019/oopp-group-43/template/badges/master/build.svg)](https://gitlab.ewi.tudelft.nl/cse1105/2018-2019/oopp-group-43/template)
## Getting started
You can install greenify with gradle, if you already have gradle on your machine, run:
You can run greenify with gradle. To start the server, run:
```
gradle install something tralala
```
Do you not have gradle on your machine, run:
```
./gradlew install something tralala
cd <FILE-LOCATION>/greenify/src/server
gradle build
gradle bootrun
```
With the following you can start the application
```
gradle greenify bootrun
```
or without gradle on your device:
```
./gradlew greenify bootrun
cd <FILE-LOCATION>/greenify/src/client
gradle build
gradle bootrun
```
## Running the tests
The tests cover all non-GUI code:
```
cd <FILE-LOCATION>/greenify
gradle check
```