jepler/knitting_machine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request #2 from tian2992/master

Browse source 
Improving readme readability
This commit is contained in:
Steve Conklin 2014-04-17 18:06:05 -05:00
commit c1b55c35c0
1 changed files with 42 additions and 47 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

89
README → README.md
View file

@ -1,6 +1,9 @@
# Electroknit
Please see the Changelog file for the latest changes
=== QUICK START ===
## Quick Start
Install python dependencies with pip and execute script guimain.py to start the
@ -12,52 +15,7 @@ pip install -r requirements.txt
python guimain.py
```
This application can start floppy disk emulator and provides means to download/upload patterns and modify them.
It is based on existing python scripts, which were slightly modified for better user experience in graphical application.
=================
These files are related to the Brother KH-930E knitting machine, and other similar models.
=== NOTE ===
The emulator script was named PDDemulate-1.0.py, and the instructions in a lor of forums for using it have that name.
The script has been renamed, and is now simply PDDemulate.py.
============
The files in the top directory are the ones used for the knitting project that Becky Stern and Limor Fried did:
http://blog.makezine.com/archive/2010/11/how-to_hacking_the_brother_kh-930e.html
http://blog.craftzine.com/archive/2010/11/hack_your_knitting_machine.html
The subdirectories contain the following:
* docs:
Documentation for the project, including the data file format information and
scans of old manuals which are hard to find.
* experimental:
Some never-tested code to talk to a Tandy PDD-1 or Brother disk drive.
* file-analysis:
Various scripts used to reverse-engineer the brother data format, as well as some spreadsheets used.
These may or may nor work, but may be useful for some.
* test-data:
A saved set of data from the PDDemulator, with dicumentation abotu what's saved in each memory location.
A good way to play with the file analysis tools, and may give some insight into the reverse engineering
process.
* textconversion
The beginnings of work to convert text to a knittable banner.
--------------------------
##Introduction
The Brother knitting machines can save data to an external floppy disk drive, which connects to the machine using a serial cable.
@ -70,6 +28,43 @@ Most of the formatting of the saved data files has been figured out, and the too
There is also an example of how to generate a text banner in a .png image file,
which may be useful to some.
This application can start floppy disk emulator and provides means to download/upload patterns and modify them.
It is based on existing python scripts, which were slightly modified for better user experience in graphical application.
These files are related to the Brother KH-930E knitting machine, and other similar models.
The emulator script was named PDDemulate-1.0.py, and the instructions in a lot of forums for using it have that name.
The script has been renamed, and is now simply PDDemulate.py.
----
The files in the top directory are the ones used for the knitting project that Becky Stern and Limor Fried did:
http://blog.makezine.com/archive/2010/11/how-to_hacking_the_brother_kh-930e.html
http://blog.craftzine.com/archive/2010/11/hack_your_knitting_machine.html
##Subdirectories
* **docs**:
Documentation for the project, including the data file format information and scans of old manuals which are hard to find.
* **experimental**:
Some never-tested code to talk to a Tandy PDD-1 or Brother disk drive.
* **file-analysis**:
Various scripts used to reverse-engineer the brother data format, as well as some spreadsheets used.
These may or may nor work, but may be useful for some.
* **test-data**:
A saved set of data from the PDDemulator, with dicumentation abotu what's saved in each memory location.
A good way to play with the file analysis tools, and may give some insight into the reverse engineering
process.
* **textconversion:**
The beginnings of work to convert text to a knittable banner.
--------------------------
The work that Steve Conklin did was based on earlier work by John R. Hogerhuis.
This extended by Becky and Limor and others, including Travis Goodspeed: