pupate

getting-started.md

 1---
 2title: Getting Started
 3---
 4
 5Hi!
 6
 7Pupate is the puzzle compiler and previewer for
 8[MOTH](https://github.com/dirtbags/moth/)
 9and other puzzle-based architectures.
10
11Here's how to get started with your first category!
12
13# Startup steps
14
15The first time you run `cocoon`, 
16it will create a new `categories` folder in your `Documents` folder,
17and place an example `counting` category there.
18It then serves web requests at http://localhost:8080/
19
201. Open [the pupate front page](/) in a browser to see the `counting` category!
212. Open the `counting` folder in a programmer's editor like VS Code, emacs, or vim.
223. Try changing some files to see what happens in your web browser.
23
24# Things to remember
25
26* Every puzzle directory needs a `puzzle.md` file.
27* Some Windows editors will add parts to the filename without telling you:
28  use a programmer's editor like VS Code, vim, emacs, or Notepad++ to avoid this!
29* Sometimes pupate gets confused and needs to be restarted.
30
31# Next steps
32
33* Provide the `-unsafe` flag to see some debugging information in puzzles:
34  `pupate -unsafe Documents/counting`
35* Read more about the [puzzle format](puzzle-format.md).
36* Put on your fancy pants and try [scripting](scripting.md) a puzzle.