https://github.com/t0mpr1c3/knotty

A domain-specific language for knitting patterns
https://github.com/t0mpr1c3/knotty

dsl knitting knitting-pattern knitting-patterns racket typed-racket

Last synced: 4 months ago
JSON representation

A domain-specific language for knitting patterns

• Host: GitHub
• URL: https://github.com/t0mpr1c3/knotty
• Owner: t0mpr1c3
• License: gpl-3.0
• Created: 2023-11-08T11:43:32.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-03-30T06:00:25.000Z (about 1 year ago)
• Last Synced: 2025-03-30T06:24:25.251Z (about 1 year ago)
• Topics: dsl, knitting, knitting-pattern, knitting-patterns, racket, typed-racket
• Language: Racket
• Homepage: https://t0mpr1c3.github.io/knotty/index.html
• Size: 8.37 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Knotty

Domain Specific Language for knitting patterns

[![Coverage Status](https://coveralls.io/repos/github/t0mpr1c3/knotty/badge.svg?branch=main)](https://coveralls.io/github/t0mpr1c3/knotty?branch=main)

[Documentation](https://t0mpr1c3.github.io/knotty/index.html)

## Description

Grid-based editors are handy for colorwork.

[Knitspeak](https://stitch-maps.com/about/knitspeak/) is great for lace.

Knotty aims for the best of both worlds. It's a way to design knitting patterns

that incorporate both textured stitches and multiple colors of yarn.

## Features

Knotty patterns are encoded in a format that is easy for humans to write and parse,

but is also highly structured.

Patterns can be viewed and saved in an HTML format that contains an interactive

knitting chart and written instructions. You can also import and export Knitspeak

files, and create Fair Isle patterns directly from color graphics.

Knotty has been coded as a module for

[Typed Racket](https://docs.racket-lang.org/ts-guide/). Reference information

is available in the [manual](https://t0mpr1c3.github.io/knotty/index.html).

A [Knotty executable](https://github.com/t0mpr1c3/knotty/releases) is also

available that can be used from the command line to convert knitting patterns from

one format to another.

## Getting Started

Clone [this repository](https://github.com/t0mpr1c3/knotty).

Download the latest version of [Racket](https://download.racket-lang.org/)

for your operating system. It comes with the graphical application DrRacket.

Open DrRacket and select the menu option "File > Install Package". Type

"knotty" into the text box and press "Install".

Open the test script `demo.rkt` from the `knotty-lib` directory of the repository

and press "Run" in the top right of the window. The demonstration script contains

a very short knitting pattern, together with many lines of comments describing how

to go about making your own.