Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sumpfork committed Nov 21, 2017
1 parent ba0c184 commit 10dbb6d
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
# 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

This is a script and library to generate card dividers for storing cards for the game [Dominion](https://boardgamegeek.com/boardgame/36218/dominion). If you are just looking go generate some dominion dividers, there is no need to install this script as I host a [live version of this generator code](http://domtabs.sandflea.org). However, if you want to use arguments that I don't expose on that page, or change the code, or contribute to the project the full generation code (not the web interface or the fonts) is included here, and contributions are more than welcome.

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).
Expand Down
7 changes: 4 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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="[email protected]",
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."
)

0 comments on commit 10dbb6d

Please sign in to comment.