allyarnsarebeautiful / ayab-desktop Goto Github PK

Meshes should have colors We can safely assume that the same color maps to the same yarn.

This is just to find a common understanding and expectations of documentation.
Currently, the python code of the AYAB GUI is documented with documentation strings, which enables code documentation being generated e.g. with doxygen (https://www.stack.nl/~dimitri/doxygen/manual/docblocks.html#pythonblocks).
Concepts, API and Dev/Build instructions are documented with Sphinx (https://all-yarns-are-beautiful.readthedocs.io from https://bitbucket.org/tian2992/ayab-apparat/src/355e9612c141/software/python/docs/?at=develop).

@niccokunzmann , @kirstin what is your preferred way to do documentation, would you like to change something of this?
At least, we could move to allyarnsarebeautiful.readthedocs.io to keep the naming consistent.

This knitting plugin receives all the instructions that a machine can not do. It should be able to do anything.

the language should be shown as described in wikipedia,

either

• continuous builds
• update mechanism

ask Sven Köhler

it should be possible to save, not only load the knitting patterns

• create JSONDumper
• convert knittingpattern to primitive structure
• do not add information that is in instructions by default

the default insrtcutions of the library should be tested for

• mesh consumption
• mesh production
• description text

the knitting pattern structure should be manipulated. Therefore we need tests for adding and removing instructions.

The instructions from #1 should be specified in a format that allows parsing them.

Ideas: each mesh has a ordered list of meshes that it goes through and an ordered list of meshes that go through it as well es a direction (right, left) for each of the listed meshes.

For the border we need a different approach to know how to embed the instructions.

Test the pattern found in knittingpattern/convert/test/test_patterns/cast_on_and_bind_off.json

Some representative DROPs knitting instructions should be converted to .knit format, so one can test out whether the conversions of #2 work.

To enable use with ayab, we can create a png graphic.

I.e. a heart

find a way to specify how knitting instructions can be converted to instructions for the machine

Part of #9.

• create English text for each instruction
• convert knittingpattern to english text
• be aware of internationalization

The tested rendering examples do not cover all the nice cases that you want.
We should create more such examples.

the readme file should contain RST

• how to install code from pypi
• how to check out and install manually
• a link for the developers md file

Which data will be stored in a .knit instruction? (Instructions, Motif Data, ...)
How is it stored? (xml, json, ..., human readable, ...)
How to handle machine model specific parameters and instructions (special carriages types, ...)

This should make clear, how to use their software to create sewing patterns for our software

could also be a deb package, ...

seems like uploading a new version does not automatically update the reamde on pypi
investigate this. and propose an automatic update mechanistm in develop.md

After #1 we should make sure that we have a representative set of instructions. We should check back with people from the facebook group if that already matches their mental model.

This page should be read proof by kirstin.

Part of #9.
The Humans will not like a lot of text. Show diffs like: in this line do as in that line but this is different.

http://www.stitchcode.com/

Part of #9.

siehe #42, KG882 Option einfügen

Part of #9.
pot cloth for example.

add the default instructions form the wiki to the knittingpattern library
also add bindoff and knitstart

Here we can find sets of knitting instructions.
These should be put into the Wiki or a table where we can list all of them. They are the basis of the knit files.

Licenses are extremely important. They determine how a community collaborates.
We should choose a free OSS license.

What are your preferences?
Examples:

• MIT - if everything should be possible
• LGPL - if proprietary software is allows to be built with it but our work is still free and modifyable
• GPL if only free software should be built with it.
• more

I would vote for something like LGPL in order to allow last-century knitting-software producers to support our format, ...

@kirstin @mariobehling @andz82 @chris007de please choose a license (does not need to be mentioned above)

Im Wiki fehlt noch das dritte Bild.

use favicon from the website

There should be a possibility to show the knitting instructions in graphical way.
I.E. an SVG file which can be used as overview.
This would also allow for a generalized way of instructions on how to draw .knit instructions as lines.

render knitting instructions as svg

The result should be line wise and all equivalents should be removed.

The KH-910 is not able to do all instructions.
The subset of the instructions should be listed and matched.

We have instructions that are equivalent. These should be know as generally equivalent and not handled by the KH-910. (i.e. if you knit from left to right, there will be different, inverted instructions) When coming across them they should be put somewhere else.

some things are done in represition, e.g. simple patterns they should be displayed in an understandable way

• two left, two right, ...
• three left, three right, ...
• patent, ...

remove duplicates,
test code