From 10dbb6d82b6861504a247e6e345c68259167edfc Mon Sep 17 00:00:00 2001 From: Sumpfork Date: Tue, 21 Nov 2017 14:13:26 -0800 Subject: [PATCH] update readme --- README.md | 6 +++++- setup.py | 7 ++++--- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 42e86c29..3cdd0563 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Dominion Divider Generation -[![Join the chat at https://gitter.im/dominiontabs/Lobby](https://badges.gitter.im/dominiontabs/Lobby.svg)](https://gitter.im/dominiontabs/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +[![Build Status](https://travis-ci.org/sumpfork/dominiontabs.svg?branch=master)](https://travis-ci.org/sumpfork/dominiontabs) ## Introduction @@ -8,6 +8,10 @@ This is a script and library to generate card dividers for storing cards for the Again, to generate tabs go to the ***[Online Generator](http://domtabs.sandflea.org)***. +## Installation + +If you do need to install the package locally (the script provides a lot more options than the web-based generator), a simple `pip install domdiv` should suffice, providing a command by the name of `dominion_dividers`. However, see the note under Prerequisites->Fonts below as the default install will fall back on a font that doesn't match the cards (though most people don't notice). + ## Translations If you would like to help with translations to new (or updating existing) languages, please see [instructions here] (https://github.com/sumpfork/dominiontabs/blob/master/domdiv/card_db/translation.md). diff --git a/setup.py b/setup.py index 6d30d6fb..9edb617a 100644 --- a/setup.py +++ b/setup.py @@ -13,11 +13,12 @@ packages=find_packages(exclude=['tests']), install_requires=["reportlab>=3.4.0", "Pillow>=4.1.0"], + url='http://domtabs.sandflea.org', include_package_data=True, author="Peter Gorniak", author_email="sumpfork@mailmight.net", description="Divider Generation for the Dominion Card Game", - url="http://domtabs.sandflea.org", - download_url='https://github.com/sumpfork/dominiontabs/archive/v{}.tar.gz'.format(version), - keywords=['boardgame', 'cardgame', 'dividers'] + keywords=['boardgame', 'cardgame', 'dividers'], + long_description="This script and library generate dividers for the Dominion Card Game by Rio Grande Games.\ + See it in action at http://domtabs.sandflea.org." )