Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,11 @@ To run the project, call the following:
```
python banana.py # may need to use python3 if on Mac or Windows
```

## Mascot pattern generator

Generate a Markdown crochet or knitting pattern:

```
perl scripts/generate_mascot_pattern.pl --banana 3 --goose 1 --goblin 2 --yarn dk --height 22 --terminology uk --emoji --output mascot.md
```
19 changes: 19 additions & 0 deletions docs/mascot-pattern-generator.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Mascot Pattern Generator

`scripts/generate_mascot_pattern.pl` creates a Markdown craft pattern for a project mascot.

Example:

```sh
perl scripts/generate_mascot_pattern.pl --banana 3 --goose 1 --goblin 2 --yarn dk --height 22 --terminology uk --emoji --output mascot.md
```

The generator supports:

- relative feature ratios with `--banana`, `--goose`, and `--goblin`
- `crochet` or `knit` instructions through `--craft`
- US or UK crochet stitch terminology through `--terminology`
- emoji instructions instead of English prose through `--emoji`
- yarn-weight scaling through `--yarn`
- finished-size scaling through `--height`
- stdout output or file output through `--output`
Loading