search

fossasia / knitlib

Knitting backend library for knitting machines
GNU Lesser General Public License v3.0
1.54k stars 14 forks source link

Documentation of KnitLib #60

Open shiluka opened 9 years ago

mariobehling commented 9 years ago

I have added a structure as a start to the readme.rst. It results in one of the tests failing. Please check what is the relevance here and complete the file. We need the necessary information to show up easily. Cheers.

tian2992 commented 9 years ago

I think that at least we need install info for development/production, simple troubleshooting, status and supported features of each machine plugins for the readme.

On Tue, 25 Aug 2015 11:51 Mario Behling notifications@github.com wrote:

I have added a structure as a start to the readme.rst. It results in one of the tests failing. Please check what is the relevance here and complete the file. We need the necessary information to show up easily. Cheers.

— Reply to this email directly or view it on GitHub https://github.com/fashiontec/knitlib/issues/60#issuecomment-134684534.

mariobehling commented 9 years ago

@tian2992 What I would like to do: Here is the knitapps repo (https://github.com/fashiontec/knitapps) we started with as a reference. In future there might be more apps or modules. I would like to be able to copy/paste every document that is referenced here into the respective area and (after changing the heading numbering) I would like to be able to copy/paste each readme into here. Then I could easily give it to people. This is the same "modular" approach we go with the apps.