diff --git a/README.rst b/README.rst new file mode 100644 index 0000000000..041f0b4b8d --- /dev/null +++ b/README.rst @@ -0,0 +1,63 @@ +|pypi| |builds| |coverage| |python| |license| + + +.. image:: https://gitlab.com/mayan-edms/mayan-edms/raw/master/docs/_static/mayan_logo.png + :align: center + :width: 200 + :height: 200 + +Mayan EDMS is a document management system. Its main purpose is to store, +introspect, and categorize files, with a strong emphasis on preserving the +contextual and business information of documents. It can also OCR, preview, +label, sign, send, and receive thoses files. Other features of interest +are its workflow system, role based access control, and REST API. + +.. image:: https://gitlab.com/mayan-edms/mayan-edms/raw/master/docs/_static/overview.gif + :align: center + + +The installation procedure uses the Docker container manager +(docker.com). Make sure Docker is properly installed and working before +attempting to install Mayan EDMS. + +Step 1- Initialize the installation + +.. code:: bash + + docker run --rm -v mayan_media:/var/lib/mayan \ + -v mayan_settings:/etc/mayan mayanedms/mayanedms mayan:init + +Step 2- Deploy a container + +.. code:: bash + + docker run -d --name mayan-edms --restart=always -p 80:80 \ + -v mayan_media:/var/lib/mayan -v mayan_settings:/etc/mayan mayanedms/mayanedms + +Step 3- Open a browser and go to http://localhost + + +Important links + +- `Homepage `__ +- `Videos `__ +- `Documentation `__ +- `Paid support `__ +- `Roadmap `__ +- `Contributing `__ +- `Community forum `__ +- `Community forum archive `__ +- `Source code, issues, bugs `__ +- `Plug-ins, other related projects `__ +- `Translations `__ + + + +.. |pypi| image:: http://img.shields.io/pypi/v/mayan-edms.svg + :target: http://badge.fury.io/py/mayan-edms +.. |builds| image:: https://gitlab.com/mayan-edms/mayan-edms/badges/master/build.svg + :target: https://gitlab.com/mayan-edms/mayan-edms/pipelines +.. |coverage| image:: https://codecov.io/gitlab/mayan-edms/mayan-edms/coverage.svg?branch=master + :target: https://codecov.io/gitlab/mayan-edms/mayan-edms?branch=master +.. |python| image:: https://img.shields.io/pypi/pyversions/mayan-edms.svg +.. |license| image:: https://img.shields.io/pypi/l/mayan-edms.svg?style=flat diff --git a/setup.py b/setup.py index e49324b78b..b0d2b3005d 100644 --- a/setup.py +++ b/setup.py @@ -90,12 +90,8 @@ pytz==2016.7 sh==1.12.11 """.split() -try: - import pypandoc - readme = pypandoc.convert_file('README.md', 'rst') -except (IOError, ImportError): - with open('README.md') as f: - readme = f.read() +with open('README.rst') as f: + readme = f.read() with open('HISTORY.rst') as f: history = f.read()