diff --git a/README.md b/README.md index 422f55855dada485699cbfcebc91f4ccbed32799..5f972b401342d32d920c145347f66c2d15e17425 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ icartt Documentation ============= -.. include:: docs/source/usage.rst +Please have a look at docs/source/usage.rst for usage examples. Full documentation is in preparation. Contributing ============ @@ -20,3 +20,10 @@ make your changes and then [submit a merge request](https://mbees.med.uni-augsbu Installation ============ +Clone this repository / or your fork and install as "editable": + +``` +git clone https://mbees.med.uni-augsburg.de/gitlab/mbees/icartt_pypackage.git or +cd icartt_pypackage +pip install -e . +``` diff --git a/setup.py b/setup.py index 188ba424a21e2f5559204b0725feb70c401036a7..6130b48c1cf95c7545289f62366897c438803e34 100644 --- a/setup.py +++ b/setup.py @@ -7,12 +7,12 @@ def read(filename): setup(name='icartt', description='ICARTT format reader and writer', - long_description=read('README.rst') + '\n\n' + read('INSTALL.rst') + '\n\n' + read('CHANGES.rst'), + long_description=read('README.md') + '\n\n' + read('INSTALL.rst') + '\n\n' + read('CHANGES.rst'), long_description_content_type='text/markdown', - version='1.0.1', - url='https://boxmodeling.meteo.physik.uni-muenchen.de', + version='1.9.1', + url='https://mbees.med.uni-augsburg.de', author='Christoph Knote', - author_email='christoph.knote@physik.uni-muenchen.de', + author_email='christoph.knote@med.uni-augsburg.de', license='GPLv3', classifiers=[ 'Development Status :: 5 - Production/Stable', @@ -23,7 +23,6 @@ setup(name='icartt', 'Intended Audience :: Science/Research', 'License :: OSI Approved :: GNU General Public License v3 (GPLv3)', 'Operating System :: POSIX', - 'Programming Language :: Python :: 2', 'Programming Language :: Python :: 3', 'Topic :: Education', 'Topic :: Scientific/Engineering',