finn/dominiontabs
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Sumpfork 2017-11-21 14:13:26 -08:00
parent ba0c184a24
commit 10dbb6d82b
2 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -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).

7
setup.py
View File

@ -13,11 +13,12 @@ setup(
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."
)