Update README.md

tum-ens · May 15, 2019 · 751ce7a · 751ce7a
1 parent 3d3a6cd
commit 751ce7a
Showing 1 changed file with 21 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -2,8 +2,8 @@
 Bottom-up model for the simulation of heat demand profiles of urban areas
 A. Molar-Cruz @ TUM ENS
 
-Features
---------
+## Features
+
   - UrbanHeatPro is a python-based bottom-up model for the simulation of heat demand profiles of urban areas.
   - It considers both the space heating demand and hot water demand. So far, the hot water demand is calculated only for residential buildings.
   - Characteristic values for the building stock, building thermal properties, building set-temperature and annual hot water consumption are based on statistics for Germany.
@@ -12,16 +12,15 @@ Features
   - By default, the model operates on an hourly time steps. However, the temporal resolution is configurable.
 
 
-Requirements
-------------
+## Requirements
 Python 3.6 if multiprocessing is used (installation with Anaconda recommended)
 Python 2.7 (installation with Anaconda recommended)
 
 
-Input file (csv)
-----------------
-Each building is described with the following information:\n
-  A.	Area (required)
+## Input file (csv)
+Each building is described with the following information:
+<ol>
+  <li>Area (required)</li>
       Building ground floor area in m²
   B.	Use (required)
       Building use as integer:
@@ -55,9 +54,21 @@ All columns are required, if no information is given, the cell value is taken as
 This input file should be located in the corresponding folder input/buildings
 
 
-Using UrbanHeatPro
-------------------
+## Using UrbanHeatPro
 To run the model with the given input data, change the desired information in the runme.py file and run this file in the command line:
 >> python runme.py
 
 For more details please refer to the documentation file
+
+## Contributing
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+
+## Copyright
+Copyright (C) 2018-2019 TUM ENS
+
+This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/