From 4bedcb08103b56b659218e70344a3ea146b23ef7 Mon Sep 17 00:00:00 2001 From: Beni Cherniavsky-Paskin Date: Mon, 7 Nov 2016 16:54:10 +0200 Subject: [PATCH] Switch to reStructuredText README PyPI doesn't render markdown, it parses README.md assuming reST rules: https://github.com/pypa/pypi-legacy/issues/148 which currently causes joined lines on https://pypi.python.org/pypi/manageiq-api-client-python/ Using README.rst with reST syntax is the simplest workaround. --- README.md => README.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) rename README.md => README.rst (83%) diff --git a/README.md b/README.rst similarity index 83% rename from README.md rename to README.rst index e6df30a..a3e8c61 100644 --- a/README.md +++ b/README.rst @@ -7,18 +7,18 @@ This python package provides the ManageIQ API Client library. Getting Started --------------- -Preparing your python virtual environment: +Preparing your python virtual environment:: $ virtualenv venv $ source venv/bin/activate $ pip install -e . # To create an editable install of this package -If you want to install it directly from GitHub: +If you want to install it directly from GitHub:: $ pip install git+https://github.com/ManageIQ/manageiq-api-client-python.git To run the example present in this repository you probably need to configure -your options (if different from the default shown here): +your options (if different from the default shown here):: $ export MIQURL=http://localhost:3000/api $ export MIQUSERNAME=admin