Use README.md on pypi

This commit is contained in:
Dylan Araps 2017-07-25 16:22:15 +10:00
parent c787174f75
commit 238d07ce41
2 changed files with 8 additions and 7 deletions

View File

@ -2,7 +2,7 @@
[![PyPI](https://img.shields.io/pypi/v/pywal.svg)](https://pypi.python.org/pypi/pywal/) [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.md) [![Build Status](https://travis-ci.org/dylanaraps/pywal.svg?branch=master)](https://travis-ci.org/dylanaraps/pywal)
**\[[Installation](https://github.com/dylanaraps/pywal/wiki/Installation)\] \[[Getting Started](https://github.com/dylanaraps/pywal/wiki/Getting-Started)\] \[[Customization](https://github.com/dylanaraps/pywal/wiki/Customization)\] \[[Wiki](https://github.com/dylanaraps/pywal/wiki)\]**
\[[Installation](https://github.com/dylanaraps/pywal/wiki/Installation)\] \[[Getting Started](https://github.com/dylanaraps/pywal/wiki/Getting-Started)\] \[[Customization](https://github.com/dylanaraps/pywal/wiki/Customization)\] \[[Wiki](https://github.com/dylanaraps/pywal/wiki)\]
`wal` is a script that takes an image (or a directory of images), generates a colorscheme (using `imagemagick`) and then changes all of your open terminal's colors to the new colorscheme on the fly. `wal` then caches each generated colorscheme so that cycling through wallpapers while changing colorschemes is instantaneous.

View File

@ -8,11 +8,12 @@ except (ImportError, SyntaxError):
quit(1)
DESC = (
"View the DOCS at: https://github.com/dylanaraps/pywal\n\n"
"Pypi doesn't like markdown OR rst with anchor links so "
"you'll have to view the documentation elsewhere.\n"
)
try:
import pypandoc
LONG_DESC = pypandoc.convert("README.md", "rst")
except(IOError, ImportError):
LONG_DESC = open('README.md').read()
VERSION = pywal.__version__
DOWNLOAD = "https://github.com/dylanaraps/pywal/archive/%s.tar.gz" % VERSION
@ -24,7 +25,7 @@ setuptools.setup(
author="Dylan Araps",
author_email="dylan.araps@gmail.com",
description="Generate and change colorschemes on the fly",
long_description=DESC,
long_description=LONG_DESC,
license="MIT",
url="https://github.com/dylanaraps/pywal",
download_url=DOWNLOAD,