diff --git a/README.md b/README.md index 3907087c07e5e768974987ba78b103065b2b57b3..e9e110ee8f737612ce26686fa7ed8020e4fd909a 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,13 @@ This ensures that the code snippets work as intended. # Installation [](https://srv.sauerburger.com/esel/doxec/commits/master) -You can simply clone the repository and run the setup script to get doxec. +You can install the package using pip + +```bash +$ pip install doxec +``` + +or you can clone the repository and run the setup script to get doxec. <!-- console diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000000000000000000000000000000000000..b88034e414bc7b80d686e3c94d516305348053ea --- /dev/null +++ b/setup.cfg @@ -0,0 +1,2 @@ +[metadata] +description-file = README.md diff --git a/setup.py b/setup.py index 46ba73ef774c692c6c0707f29bbb69054d8db1a9..bbad803b990529328001578e9cfde86d17ca3c3e 100644 --- a/setup.py +++ b/setup.py @@ -14,6 +14,7 @@ setup( packages=['doxec'], scripts=['bin/doxec'], test_suite='doxec.tests', + url="https://gitlab.sauerburger.com/frank/doxec", classifiers=[ "Development Status :: 3 - Alpha", "Environment :: Console",