Commit 7ed7383f authored by Michiel Cottaar's avatar Michiel Cottaar
Browse files

DOC: update README file

parent 4b8c37b7
mcutils
=======
My personal library with a wide variety of tools and utilities
Usage
-----
Command line scripts are available through a single command: `mc_script`.
Installation
------------
```sh
pip install git+https://git.fmrib.ox.ac.uk/ndcn0236/mcutils.git
```
Documentation
-------------
Documentation can be found
[here](https://users.fmrib.ox.ac.uk/~ndcn0236/doc/mcutils/).
Authors
-------
`mcutils` was written by `Michiel Cottaar <MichielCottaar@protonmail.com>`_.
mcutils
=======
.. image:: https://img.shields.io/pypi/v/mcutils.svg
:target: https://pypi.python.org/pypi/mcutils
:alt: Latest PyPI version
.. image:: https://travis-ci.org/borntyping/cookiecutter-pypackage-minimal.png
:target: https://travis-ci.org/borntyping/cookiecutter-pypackage-minimal
:alt: Latest Travis CI build status
My personal utilities library
Usage
-----
Installation
------------
Requirements
^^^^^^^^^^^^
Compatibility
-------------
Licence
-------
Authors
-------
`mcutils` was written by `Michiel Cottaar <MichielCottaar@protonmail.com>`_.
......@@ -40,7 +40,7 @@ setuptools.setup(
author_email="MichielCottaar@protonmail.com",
description="My personal utilities library",
long_description=open('README.rst').read(),
long_description=open('README.md').read(),
packages=setuptools.find_packages(exclude=('tests*', )),
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment