Update README.md
Browse files
README.md
CHANGED
|
@@ -1,3 +1,13 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
# 🧶 Carpet Weaving Map Generator
|
| 2 |
|
| 3 |
Convert any image into a technical carpet weaving pattern with precise knot mapping and color specifications.
|
|
@@ -54,49 +64,6 @@ Convert any image into a technical carpet weaving pattern with precise knot mapp
|
|
| 54 |
- Grid overlay with centimeter markings
|
| 55 |
- Color legend and specifications
|
| 56 |
|
| 57 |
-
## 🚀 Deployment on Hugging Face Spaces
|
| 58 |
-
|
| 59 |
-
1. Create a new Space on [Hugging Face](https://huggingface.co/spaces)
|
| 60 |
-
2. Choose "Gradio" as the SDK
|
| 61 |
-
3. Upload these files:
|
| 62 |
-
- `app.py` (main application)
|
| 63 |
-
- `requirements.txt` (dependencies)
|
| 64 |
-
- `README.md` (this file)
|
| 65 |
-
4. Your Space will automatically build and deploy
|
| 66 |
-
|
| 67 |
-
## 🛠️ Local Development
|
| 68 |
-
|
| 69 |
-
```bash
|
| 70 |
-
# Clone the repository
|
| 71 |
-
git clone <your-repo-url>
|
| 72 |
-
cd carpet-weaving-map
|
| 73 |
-
|
| 74 |
-
# Install dependencies
|
| 75 |
-
pip install -r requirements.txt
|
| 76 |
-
|
| 77 |
-
# Run the application
|
| 78 |
-
python app.py
|
| 79 |
-
```
|
| 80 |
-
|
| 81 |
-
## 📖 Example Usage
|
| 82 |
-
|
| 83 |
-
```python
|
| 84 |
-
# For fine detail work
|
| 85 |
-
knots_per_cm = 15
|
| 86 |
-
n_colors = 20
|
| 87 |
-
carpet_size = 60cm × 90cm
|
| 88 |
-
|
| 89 |
-
# For standard carpets
|
| 90 |
-
knots_per_cm = 10
|
| 91 |
-
n_colors = 16
|
| 92 |
-
carpet_size = 80cm × 120cm
|
| 93 |
-
|
| 94 |
-
# For rustic/tribal style
|
| 95 |
-
knots_per_cm = 6
|
| 96 |
-
n_colors = 12
|
| 97 |
-
carpet_size = 100cm × 150cm
|
| 98 |
-
```
|
| 99 |
-
|
| 100 |
## 🎨 Best Practices
|
| 101 |
|
| 102 |
### Image Selection
|
|
@@ -114,35 +81,9 @@ carpet_size = 100cm × 150cm
|
|
| 114 |
- Lower density = faster weaving but less detail
|
| 115 |
- Consider the skill level of the weaver
|
| 116 |
|
| 117 |
-
## 🔬 Technical Details
|
| 118 |
-
|
| 119 |
-
### Color Reduction Algorithm
|
| 120 |
-
Uses K-means clustering to identify the most representative colors in the image, ensuring the palette is both accurate and weavable.
|
| 121 |
-
|
| 122 |
-
### Grid Generation
|
| 123 |
-
Resizes the image to exact knot dimensions and maps each pixel to the nearest palette color, creating a precise weaving pattern.
|
| 124 |
-
|
| 125 |
-
### Export Format
|
| 126 |
-
CSV files use standard comma-separated format readable by spreadsheet software and weaving applications.
|
| 127 |
-
|
| 128 |
## 🤝 Contributing
|
| 129 |
|
| 130 |
-
Contributions are welcome! Please feel free to submit a Pull Request.
|
| 131 |
-
|
| 132 |
-
- Additional export formats
|
| 133 |
-
- More color palettes
|
| 134 |
-
- Advanced dithering algorithms
|
| 135 |
-
- Integration with weaving software APIs
|
| 136 |
-
|
| 137 |
-
## 📄 License
|
| 138 |
-
|
| 139 |
-
This project is open source and available under the MIT License.
|
| 140 |
-
|
| 141 |
-
## 🙏 Acknowledgments
|
| 142 |
-
|
| 143 |
-
- K-means clustering for color reduction
|
| 144 |
-
- Gradio for the beautiful web interface
|
| 145 |
-
- The carpet weaving community for inspiration and technical guidance
|
| 146 |
|
| 147 |
---
|
| 148 |
|
|
|
|
| 1 |
+
---
|
| 2 |
+
title: Carpet Weaving Map Generator
|
| 3 |
+
emoji: 🧶
|
| 4 |
+
colorFrom: red
|
| 5 |
+
colorTo: yellow
|
| 6 |
+
sdk: gradio
|
| 7 |
+
app_file: app.py
|
| 8 |
+
pinned: false
|
| 9 |
+
---
|
| 10 |
+
|
| 11 |
# 🧶 Carpet Weaving Map Generator
|
| 12 |
|
| 13 |
Convert any image into a technical carpet weaving pattern with precise knot mapping and color specifications.
|
|
|
|
| 64 |
- Grid overlay with centimeter markings
|
| 65 |
- Color legend and specifications
|
| 66 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 67 |
## 🎨 Best Practices
|
| 68 |
|
| 69 |
### Image Selection
|
|
|
|
| 81 |
- Lower density = faster weaving but less detail
|
| 82 |
- Consider the skill level of the weaver
|
| 83 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 84 |
## 🤝 Contributing
|
| 85 |
|
| 86 |
+
Contributions are welcome! Please feel free to submit a Pull Request.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 87 |
|
| 88 |
---
|
| 89 |
|