dakedres/ronin
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

*

Browse Source
This commit is contained in:
Devine Lu Linvega 2017-09-27 13:59:41 +13:00
parent 1267aa4c84
commit 18d74479a2
2 changed files with 23 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -8,32 +8,45 @@ Ronin is a simple open-source graphic design tool.
- `size`, default 4 - `size`, default 4
- `color`, default #000 - `color`, default #000
- `opacity`, default 1 - `opacity`, default 1
### Methods ### Methods
### Ports ### Ports
- `->speed`{false,true}, **0/50** The cursor speed. - `->speed` *false,true* **0/50** The cursor speed.
- `->distance`{false,true}, **0/null** The cursor distance. - `->distance` *false,true* **0/null** The cursor distance.
- `->red`{true,true}, **0/255** The brush color value(red). - `->red` *true,true* **0/255** The brush color value(red).
- `->green`{true,true}, **0/255** The brush color value(green). - `->green` *true,true* **0/255** The brush color value(green).
- `->blue`{true,true}, **0/255** The brush color value(blue). - `->blue` *true,true* **0/255** The brush color value(blue).
## eraser ## eraser
### Settings ### Settings
### Methods ### Methods
### Ports ### Ports
## frame ## frame
### Settings ### Settings
- `width`, default 930 - `width`, default 930
- `height`, default 540 - `height`, default 540
### Methods ### Methods
- `resize:`, no details. - `resize:`, no details.
- `rescale:`, no details. - `rescale:`, no details.
- `crop:`, no details. - `crop:`, no details.
### Ports ### Ports
## line ## line
### Settings ### Settings
- `steps`, default 100 - `steps`, default 100
### Methods ### Methods
- `tween:`, no details. - `tween:`, no details.
- `stroke:`, no details. - `stroke:`, no details.
### Ports ### Ports
## License ## License
See the [LICENSE](LICENSE.md) file for license rights and limitations (CC). See the [LICENSE](LICENSE.md) file for license rights and limitations (CC).

10
sources/scripts/docs.js
View File

@ -37,11 +37,11 @@ function Docs()
for(module_name in modules){ for(module_name in modules){
var module = modules[module_name]; var module = modules[module_name];
html += "## "+module_name+"\n"; html += "## "+module_name+"\n";
html += this.print_settings(module.settings); html += this.print_settings(module.settings)+"\n";
html += this.print_methods(module.methods); html += this.print_methods(module.methods)+"\n";
html += this.print_ports(module.ports); html += this.print_ports(module.ports)+"\n";
} }
return html; return html+"\n";
} }
this.print_settings = function(settings) this.print_settings = function(settings)
@ -73,7 +73,7 @@ function Docs()
for(port_name in ports){ for(port_name in ports){
var port = ports[port_name]; var port = ports[port_name];
console.log(ports); console.log(ports);
html += "- `->"+port.name+"`{"+port.input+","+port.output+"}, **"+port.value+"/"+port.max+"** "+port.docs+".\n"; html += "- `->"+port.name+"` *"+port.input+","+port.output+"* **"+port.value+"/"+port.max+"** "+port.docs+".\n";
} }
return html; return html;
} }