Skip to content

QUICKSTART.md

Latest commit

 

History

History
194 lines (132 loc) · 4.36 KB

QUICKSTART.md

File metadata and controls

194 lines (132 loc) · 4.36 KB

🚀 Quick Start Guide

Get up and running in 5 minutes! Create your first custom sock pattern now.

⚡ Less-Than-A-Minute Setup

Step 1️⃣: Make It Executable

chmod +x sock_pattern_generator.sh

Step 2️⃣: Verify It Works (Optional)

sh -n sock_pattern_generator.sh

If you see no errors, you're good to go! ✅

🚀 Your First Pattern in 3 Steps

Step 1: Start the script (details below if you are unfamiliar)

./sock_pattern_generator.sh

Step 2: Answer the prompts

(Takes ~2-3 minutes, just follow along!)

Step 3: Review & save

Preview your pattern, make any edits, then save it

Done! 🎉 You now have a custom knitting pattern ready to go

🎯 Running the Script

./sock_pattern_generator.sh

You'll be guided through a friendly, step-by-step process with clear prompts and automatic screen clearing between sections. Total time: ~2-3 minutes to generate a complete pattern!

This invokes the friendly, step-by-step process. Total time: ~2-3 minutes to generate a complete pattern!

📋 What You Need

Requirement Details
🖥️ System Any Unix-like system (Linux, macOS, WSL)
🐚 Shell POSIX-compliant (sh, bash, zsh, etc.)
🛠️ Tools awk, clear, printf (usually pre-installed)
📦 Dependencies None!

🎬 Interactive Session Walkthrough

Here's what happens when you run the script:

1. 🦶 Foot Size
   Choose shoe size or enter custom dimensions

2. 📊 Gauge Swatch
   Enter stitches/rows per inch, stitches/rows per given number of centimeters, or enter customer measurments

3. 🎨 Pattern Choices
   Pick leg style, cuff ribbing, toe type, heel construction

4. 📏 Measurements
   Leg length, cuff length

5. 🧶 Yarn Details (Optional)
   Brand, line/weight, color (all fields can be left blank)

6. 🪡 Needles
   Size and working method (DPNs, Magic Loop, Circulars)

7. 👀 Review
   Check everything looks good

8. ✏️ Edit (Optional)
   Change anything without re-entering everything

9. 📖 Generate
   Pattern created instantly!

10. 💾 Output
    Display on screen, save to file, or both

📦 Project Files Explained

File Purpose
sock_pattern_generator.sh 🎯 Main script - Run this to generate patterns
README.md 📖 Full documentation & features
API_REFERENCE.md 📚 For developers & technical details
BACKEND_INTEGRATION.md 🌐 Web backend conversion guide
QUICKSTART.md 🚀 This file!

💡 Pro Tips for Success

📏 Gauge is Everything

✓ Always make a in-the-round swatch in your actual yarn ✓ Measure in the center (edges are unreliable) ✓ Different yarns = different gauges (even same weight!) ✓ Spend 5 minutes here to save hours of frustration later

🧪 Test First

✓ Knit a small swatch of each section (cuff, leg, toe) ✓ Try on as you go ✓ Better to adjust early than unravel a whole sock!

🐛 Quick Troubleshooting

❌ "Permission denied" when running script

chmod +x sock_pattern_generator.sh

❌ Script won't start

Try running with sh explicitly:

sh sock_pattern_generator.sh

❌ "awk: command not found"

Check if awk is available:

which awk

Install if needed: available from most package managers as "gawk"

❌ Calculations seem way off

  1. Double-check your gauge measurement
  2. Double-check you've selected the correct measurment units (Imperial inches vs metric centimeters)
  3. Measure in the center, not edges
  4. Try knitting a fresh swatch if unsure

❌ Can't save pattern file

Check permissions:

ls -ld .

🔍 Need more details?

🛠️ Want to customize?

See BACKEND_INTEGRATION.md for guidance on:

  • Adding new heel/toe techniques
  • Building a web interface
  • Contributing enhancements

🧦 Ready to Knit?

Your journey starts with one command:

./sock_pattern_generator.sh

Have fun creating beautiful custom socks! 🧶✨

Questions? Read the full README