UPDATE:: readme, slowly getting there

This commit is contained in:
Mika Wauben
2019-03-31 17:30:09 +00:00
parent a5dd8667b9
commit b8bb8dc91c

View File

@@ -1,42 +1,42 @@
#Greenify # Greenify
The easiest way to save CO2 and help the environment! Enter your activities and find out your carbon footprint. The easiest way to save CO2 and help the environment! Enter your activities and find out your carbon footprint.
##Getting started ## Getting started
You can install greenify with gradle, if you already have gradle on your machine, run: You can install greenify with gradle, if you already have gradle on your machine, run:
''' ```
gradle install something tralala gradle install something tralala
''' ```
Do you not have gradle on your machine, run: Do you not have gradle on your machine, run:
''' ```
./gradlew install something tralala ./gradlew install something tralala
''' ```
With the following you can start the application With the following you can start the application
''' ```
gradle greenify bootrun gradle greenify bootrun
''' ```
or without gradle on your device: or without gradle on your device:
''' ```
./gradlew greenify bootrun ./gradlew greenify bootrun
''' ```
##Running the tests ##Running the tests
The tests cover all non-GUI code: The tests cover all non-GUI code:
''' ```
gradle check gradle check
''' ```
##Licence ## Licence
GNU General Public License v3.0 GNU General Public License v3.0
##Contributors ## Contributors
### Merel Steenbergen (masteenbergen) ### Merel Steenbergen (masteenbergen)
<img src="https://user-images.githubusercontent.com/47633984/55274602-13cc1200-52da-11e9-9bd7-686d84929b83.jpg" width="100"/> <img src="https://user-images.githubusercontent.com/47633984/55274602-13cc1200-52da-11e9-9bd7-686d84929b83.jpg" width="100"/>