mindfulness-the-game/README.md

# Mindfulness: The Game

A solo journaling game about being mindful.

## Game Files

The `.md` files in the root of this project are used to generate the different releases and forms of the game for download.

## Download For Play

The `releases` folder contains the following forms of the game

## Full Game

The full game.

### Available Formats

* Markdown source code
* PDF - US Letter
* PDF - A4
* org-mode
  
## Condensed Game

A single page form of the game that can be used for prompting once familiar with the game.

### Available formats

* Markdown source code
* PDF - US Letter
* PDF - A4
* org-mode

## Quick Reference

A credit card sized form of the game. This version is designed to be printed on a7 paper, printed and trimmed to credit card size or printed on a business card.

### Available formats

* Markdown source code
* PDF - A7
* PDF - Business card
* org-mode

## Licensing

The game is licensed [Creative Commons Attribution-ShareAlike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/) and the assets used to generate the printable releases are licensed independently. Please see any assets project page for its licensing information.

## Building Releases

The following tools are used to build a release.

* make (optional, see the `Makefile` for commands to run)
* pandoc (for generating all release files)
* xetex (for generating pdf)
* Atkinson Hyperlegible font (for generating pdf, see `assets` directory for the font files)
* Deja Vu Sans Mono font (for generating pdf, see `assets` directory for the font file)
* Deja Vu Math TeX Gyre (for generating pdf, see `assets` directory for the font file)