Skip to content

Commit

Permalink
read me updated
Browse files Browse the repository at this point in the history
  • Loading branch information
sameeragunarathne committed Aug 25, 2015
1 parent 412b878 commit 3f8208f
Showing 1 changed file with 13 additions and 15 deletions.
28 changes: 13 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,14 +39,14 @@ can be used for knitting.
##Flow of UI Functions

####Loading of a pattern / image
![alt tag](https://raw.github.com/fashiontec/knitweb/tree/master/docs/demo_images/1.png)
![alt tag](/docs/demo_images/1.png?raw=true)

Step1: Choose image/pattern file from choose file dialog. It will load a image file to the image loader [left
side] and it will load the preview of the pattern to the window at the right side.

####Crop/Rotate of a pattern

![alt tag](https://raw.github.com/fashiontec/knitweb/tree/master/docs/demo_images/2.png)
![alt tag](?raw=true/docs/demo_images/2.png?raw=true)

Step1:Enable crop function by checking “Enable Cropping” check box.
Step2: select cropping area from the pattern and the click crop button at the bottom-right of the image
Expand All @@ -55,26 +55,26 @@ preview window before editing.

####Add available yarn color

![alt tag](https://raw.github.com/fashiontec/knitweb/tree/master/docs/demo_images/3.png)
![alt tag](/docs/demo_images/3.png?raw=true)

Step1:User can add available yarn colors before pattern generation by clicking add yarn color button.
Colour palette is shown to the user after clicking the button.

####Generate pattern

![alt tag](https://raw.github.com/fashiontec/knitweb/tree/master/docs/demo_images/4.png)
![alt tag](/docs/demo_images/4.png?raw=true)

Step1: Click generate pattern icon after selecting yarn colors. Then pattern will be generated for a 100 by
100 grid as the default parameters. User can regenerate the pattern by entering row and column values and
regenerate the pattern.

####Square/ Free Hand tool

![alt tag](https://raw.github.com/fashiontec/knitweb/tree/master/docs/demo_images/5.png)
![alt tag](/docs/demo_images/5.png?raw=true)

Step1:Select Square or free hand tools from the radio panel. By default it is square tool.

![alt tag](https://raw.github.com/fashiontec/knitweb/tree/master/docs/demo_images/6.png)
![alt tag](/docs/demo_images/6.png?raw=true)

Step2: Select a color from colour palette and select fill if you want to add the colour for the selected area.

Expand All @@ -84,54 +84,52 @@ Step1:Select area from the square selection if you want a color regions for sele
generate color regions for all area by selecting “Show Colour Regions[all area]”. Black coloured border
will be shown around the region

![alt tag](https://raw.github.com/fashiontec/knitweb/tree/master/docs/demo_images/8.png)
![alt tag](/docs/demo_images/8.png?raw=true)

Step2: Add a colour selected in colour palette by clicking on the relevant area you want to edit by changing
colour. In the example bottom region is recolored.

![alt tag](https://raw.github.com/fashiontec/knitweb/tree/master/docs/demo_images/9.png)
![alt tag](/docs/demo_images/9.png?raw=true)

####Available Ports/Machine type

Step1: User is shown available ports and machine types available for knitting. If it is not shown click
refresh button. Here knit web client is communicates with the knit lib server to get data.

![alt tag](https://raw.github.com/fashiontec/knitweb/tree/master/docs/demo_images/11.png)
![alt tag](/docs/demo_images/11.png?raw=true)

Step2: After editing is done click “Proceed Knitting” button to create a knit job for the pattern.

####Knitting Simulator

![alt tag](https://raw.github.com/fashiontec/knitweb/tree/master/docs/demo_images/12.png)
![alt tag](/docs/demo_images/12.png?raw=true)

Knitting simulator window will show the edited pattern. Column and row will show current stitch's knitting
row and column number. Colors field show number of colour values used in the pattern. Also there are
inputs taken such as Start Line, Infinite repeat, Start Needle, Stop Needle used for configuration of a knit
job.

![alt tag](https://raw.github.com/fashiontec/knitweb/tree/master/docs/demo_images/13.png)
![alt tag](/docs/demo_images/13.png?raw=true)

After configuration options are available to start knit job, pause and stop knit job.

####Navigation bar options

Open/Download Pattern/Import Pattern

![alt tag](https://raw.github.com/fashiontec/knitweb/tree/master/docs/demo_images/14.png)
![alt tag](/docs/demo_images/14.png?raw=true)

User is able to download the pattern after editing without going for a knit job configuration.

####Translate application page

![alt tag](https://raw.github.com/fashiontec/knitweb/tree/master/docs/demo_images/15.png)
![alt tag](/docs/demo_images/15.png?raw=true)

This feature enables translation of application fields text into several languages such as English, German,
Sinhala. Solution is added such that any language can be added to the application just by editing a language
data file. Therefore it is a scalable solution. German translation is shown below.

![alt tag](/docs/demo_images/16.png?raw=true)

#### READ MORE
https://github.com/fashiontec/knitweb/tree/master/docs


0 comments on commit 3f8208f

Please sign in to comment.