annotate README.md @ 7:c197e6f55301

documentation
author Jeff Hammel <k0scist@gmail.com>
date Sun, 24 Dec 2017 13:25:34 -0800
parents 6ded3b06fafa
children cc74dcd1548b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
51c76bbed930 introductory README commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
1 # wordplay
51c76bbed930 introductory README commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
2
51c76bbed930 introductory README commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
3 Experiments in Haskell build stack
51c76bbed930 introductory README commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
4
51c76bbed930 introductory README commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
5 ## Getting started
51c76bbed930 introductory README commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
6
51c76bbed930 introductory README commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
7 You'll want
51c76bbed930 introductory README commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
8 [stack](https://docs.haskellstack.org/en/stable/README/)
51c76bbed930 introductory README commit
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
9 installed.
1
6fa43276f012 introducing jotto
Jeff Hammel <k0scist@gmail.com>
parents: 0
diff changeset
10
7
c197e6f55301 documentation
Jeff Hammel <k0scist@gmail.com>
parents: 6
diff changeset
11 You'll probbly want to issue `stack upgrade` to
c197e6f55301 documentation
Jeff Hammel <k0scist@gmail.com>
parents: 6
diff changeset
12 ensure you're up to date
1
6fa43276f012 introducing jotto
Jeff Hammel <k0scist@gmail.com>
parents: 0
diff changeset
13
7
c197e6f55301 documentation
Jeff Hammel <k0scist@gmail.com>
parents: 6
diff changeset
14 ## Contents
c197e6f55301 documentation
Jeff Hammel <k0scist@gmail.com>
parents: 6
diff changeset
15
c197e6f55301 documentation
Jeff Hammel <k0scist@gmail.com>
parents: 6
diff changeset
16 ### Jotto
1
6fa43276f012 introducing jotto
Jeff Hammel <k0scist@gmail.com>
parents: 0
diff changeset
17
4
Jeff Hammel <k0scist@gmail.com>
parents: 1
diff changeset
18 Jotto is a game;
Jeff Hammel <k0scist@gmail.com>
parents: 1
diff changeset
19 read more about it here:
Jeff Hammel <k0scist@gmail.com>
parents: 1
diff changeset
20 https://en.wikipedia.org/wiki/Jotto .
Jeff Hammel <k0scist@gmail.com>
parents: 1
diff changeset
21
7
c197e6f55301 documentation
Jeff Hammel <k0scist@gmail.com>
parents: 6
diff changeset
22 The `jotto` package was created with
c197e6f55301 documentation
Jeff Hammel <k0scist@gmail.com>
parents: 6
diff changeset
23 ```
c197e6f55301 documentation
Jeff Hammel <k0scist@gmail.com>
parents: 6
diff changeset
24 stack new jotto
c197e6f55301 documentation
Jeff Hammel <k0scist@gmail.com>
parents: 6
diff changeset
25 ```
c197e6f55301 documentation
Jeff Hammel <k0scist@gmail.com>
parents: 6
diff changeset
26
4
Jeff Hammel <k0scist@gmail.com>
parents: 1
diff changeset
27 ## Building
Jeff Hammel <k0scist@gmail.com>
parents: 1
diff changeset
28
6
6ded3b06fafa instructions
Jeff Hammel <k0scist@gmail.com>
parents: 4
diff changeset
29 Let's try out the Shake build system:
6ded3b06fafa instructions
Jeff Hammel <k0scist@gmail.com>
parents: 4
diff changeset
30 http://shakebuild.com/
6ded3b06fafa instructions
Jeff Hammel <k0scist@gmail.com>
parents: 4
diff changeset
31 ```
6ded3b06fafa instructions
Jeff Hammel <k0scist@gmail.com>
parents: 4
diff changeset
32 stack install shake
6ded3b06fafa instructions
Jeff Hammel <k0scist@gmail.com>
parents: 4
diff changeset
33 ```