Skip to content

Commit 15fa9a3

Browse files
authored
Update README.md
1 parent f86b5f4 commit 15fa9a3

1 file changed

Lines changed: 10 additions & 3 deletions

File tree

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,24 @@ Knit App is a comprehensive Streamlit-based application designed for knitters an
88

99
## Key Features
1010
* **Pattern Digitization:** Upload any PNG/JPG and use dynamic thresholding and resampling to convert it into a pixel matrix that you can layer onto a sweater canvas.
11+
1112
* **Multi-Panel Garment IDE:** Switch between Front Panel, Back Panel, and Sleeves canvases that make up a drop shoulder sweater. The app dynamically calculates dimensions and short-row shaping based on user measurements and gauge.
13+
1214
* **Layer Design Studio:** Add, duplicate, merge, and transform (rotate, flip, mirror, scale) multiple graphics on a single canvas.
15+
1316
* **Fine-Tune Pixel Editor:** A built-in, manual spreadsheet-style editor to fine-tune individual stitches or draw custom motifs from scratch on blank 25x25 or 50x50 canvases.
14-
* **Alpha JSON Exporter:** Export your custom design to a JSON file to reuse in future projects.
17+
18+
* **Alpha JSON Exporter:** Export your custom design to a JSON file to reuse in future projects.
19+
1520
* **Master PDF Compiler:** Automatically chunks your digital canvas into a printable PDF pattern complete with cast-on counts, row instructions, and sweater specs.
21+
1622
* **Project Saving:** Serialize your entire workspace (including layers, settings, and math grids) into a JSON file to resume your work later.
1723

24+
For more in depth documentation of the features check out docs/report.ipynb
1825
---
1926

2027
## Prerequisites
21-
Before installing, ensure you have **Python 3.9 or newer** installed on your system. We highly recommend using a virtual environment (like `venv` or Anaconda) to keep dependencies clean.
28+
Before installing, ensure you have **Python 3.9 or newer** installed on your system.
2229

2330
---
2431

@@ -99,4 +106,4 @@ Distributed under the MIT License. Built as a final capstone project for the uni
99106

100107
```
101108
102-
```
109+
```

0 commit comments

Comments
 (0)