Skip to content

Commit 9c33740

Browse files
committed
Adapt documentation
1 parent 4db270c commit 9c33740

File tree

2 files changed

+11
-6
lines changed

2 files changed

+11
-6
lines changed

README.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
.. image:: https://travis-ci.org/wind-python/windpowerlib.svg?branch=dev
2+
:target: https://travis-ci.org/wind-python/windpowerlib
3+
.. image:: https://coveralls.io/repos/github/wind-python/windpowerlib/badge.svg?branch=dev
4+
:target: https://coveralls.io/github/wind-python/windpowerlib?branch=dev
5+
16
Introduction
27
=============
38

@@ -19,13 +24,13 @@ Go to the `download page <http://readthedocs.org/projects/windpowerlib/downloads
1924
Installation
2025
============
2126

22-
If you have a working Python3 environment, use pypi to install the latest windpowerlib version.
27+
If you have a working Python3 environment, use pypi to install the latest windpowerlib version. We highly recommend to use virtual environments.
2328

2429
::
2530

26-
pip3 install windpowerlib
31+
pip install windpowerlib
2732

28-
So far, the windpowerlib is mainly tested on python 3.4 but seems to work down to 2.7.
33+
So far, the windpowerlib is tested on python > 3.5 but seems to work down to 2.7.
2934
Please see the `installation page <http://oemof.readthedocs.io/en/stable/installation_and_setup.html>`_ of the oemof documentation for complete instructions on how to install python on your operating system.
3035

3136
Optional Packages

doc/getting_started.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ Go to the `download page <http://readthedocs.org/projects/windpowerlib/downloads
2323
Installation
2424
============
2525

26-
If you have a working Python3 environment, use pypi to install the latest windpowerlib version.
26+
If you have a working Python3 environment, use pypi to install the latest windpowerlib version. We highly recommend to use virtual environments.
2727

2828
::
2929

30-
pip3 install windpowerlib
30+
pip install windpowerlib
3131

32-
So far, the windpowerlib is mainly tested on python 3.4 but seems to work down to 2.7.
32+
So far, the windpowerlib is tested on python > 3.5 but seems to work down to 2.7.
3333
Please see the `installation page <http://oemof.readthedocs.io/en/stable/installation_and_setup.html>`_ of the oemof documentation for complete instructions on how to install python on your operating system.
3434

3535
Optional Packages

0 commit comments

Comments
 (0)