Skip to content

Commit b23f885

Browse files
committed
packaging + README + gitignore
1 parent 6514add commit b23f885

File tree

3 files changed

+59
-0
lines changed

3 files changed

+59
-0
lines changed

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
node_modules
2+
npm_debug.log

README.md

+31
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,34 @@ papers-generator
22
================
33

44
Generate pages with small paper tokens to print out.
5+
6+
7+
Introduction
8+
------------
9+
10+
This is a tool I use to generate pages of small paper tokens (usually with a title, a small
11+
text and an illustration) that I can then print out and cut. This is useful is you have to
12+
organize outdoor games for example, where small pieces of paper are exchanged as part of
13+
the game.
14+
15+
Usage
16+
-----
17+
18+
All you have to do is create an HTML file in this folder and open it in
19+
your browser. You can than use a browser extension such as
20+
[printpdf](https://addons.mozilla.org/En-us/firefox/addon/printpdf/)
21+
to generate a easily printable document.
22+
23+
The best way to do this is to start from the commented example HTML file
24+
[medicaments.html](examples/medicaments.html).
25+
Comments will guide you through the process of customizing the output.
26+
27+
Test
28+
-----
29+
30+
Test can be done with node.
31+
32+
```
33+
npm install
34+
npm test
35+
```

package.json

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
"name": "papers-generator",
3+
"version": "0.0.1",
4+
"author": "Jehan Bruggeman <[email protected]>",
5+
"description": "Generate papers for real-life games.",
6+
7+
"scripts": {
8+
"test": "vows --spec --isolate"
9+
},
10+
11+
"repository": {
12+
"type": "git",
13+
"url": "https://github.com/jbruggem/papers-generator.git"
14+
},
15+
16+
"dependencies" : {
17+
"domino":"*",
18+
"mocha":"*",
19+
"zepto-node":"*"
20+
},
21+
"license": "Apache License 2.0",
22+
"engines": {
23+
"node": ">=0.10"
24+
}
25+
}
26+

0 commit comments

Comments
 (0)