From 32f969a32abf2ee50821ac00cbe4339ea6cce3d5 Mon Sep 17 00:00:00 2001 From: Sean McGinnis Date: Thu, 21 Jun 2018 06:08:38 -0500 Subject: [PATCH] Correct errors in README file This changes the README from a txt to rst file for output formatting and corrects doc8 warnings causing package checks to fail. Change-Id: I5e050c71429e40d294510bf1fd294218c4dae81f --- README.txt => README.rst | 8 +++++--- setup.py | 2 +- 2 files changed, 6 insertions(+), 4 deletions(-) rename README.txt => README.rst (86%) diff --git a/README.txt b/README.rst similarity index 86% rename from README.txt rename to README.rst index 9ff8368..c0027b3 100644 --- a/README.txt +++ b/README.rst @@ -1,7 +1,8 @@ XStatic-Angular-Material --------------- +------------------------ -Angular-Material JavaScript and SCSS library packaged for setuptools (easy_install) / pip. +Angular-Material JavaScript and SCSS library packaged for setuptools +(easy_install) / pip. This package is intended to be used by **any** project that needs these files. @@ -9,5 +10,6 @@ It intentionally does **not** provide any extra code except some metadata **nor** has any extra requirements. You MAY use some minimal support code from the XStatic base package, if you like. -You can find more info about the xstatic packaging way in the package `XStatic`. +You can find more info about the xstatic packaging way in the package +`XStatic`. diff --git a/setup.py b/setup.py index 19c79fb..0ebbbb1 100644 --- a/setup.py +++ b/setup.py @@ -3,7 +3,7 @@ from xstatic.pkg import angular_material as xs # The README.txt file should be written in reST so that PyPI can use # it to generate your project's PyPI page. -long_description = open('README.txt').read() +long_description = open('README.rst').read() setup( name=xs.PACKAGE_NAME,