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

Updated docs

Browse Source
This commit is contained in:
Devine Lu Linvega 2017-09-27 13:29:13 +13:00
parent 6ffabd2318
commit 5e311fd29c
2 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
README.md
View File

@ -4,39 +4,39 @@ Ronin is a simple open-source graphic design tool.
## Modules ## Modules
## brush ## brush
### Settings ### Settings
- size - `size`, default 4
- color - `color`, default #000
- opacity - `opacity`, default 1
### Methods ### Methods
### Ports ### Ports
- speed - `speed`, no details.
- distance - `distance`, no details.
- red - `red`, no details.
- green - `green`, no details.
- blue - `blue`, no details.
- alpha - `alpha`, no details.
- x - `x`, no details.
- noise - `noise`, no details.
## eraser ## eraser
### Settings ### Settings
### Methods ### Methods
### Ports ### Ports
## frame ## frame
### Settings ### Settings
- width - `width`, default 930
- height - `height`, default 540
### Methods ### Methods
- resize - `resize`, no details.
- rescale - `rescale`, no details.
- crop - `crop`, no details.
### Ports ### Ports
## line ## line
### Settings ### Settings
- steps - `steps`, default 100
### Methods ### Methods
- tween - `tween`, no details.
- stroke - `stroke`, no details.
### Ports ### Ports
- index - `index`, no details.
## 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).

12
sources/scripts/docs.js
View File

@ -49,8 +49,8 @@ function Docs()
var html = "### Settings\n"; var html = "### Settings\n";
for(setting_name in settings){ for(setting_name in settings){
var setting = settings[setting_name]; var setting_val = settings[setting_name];
html += "- "+setting_name+"\n"; html += "- `"+setting_name+"`, default "+setting_val+"\n";
} }
return html; return html;
} }
@ -60,8 +60,8 @@ function Docs()
var html = "### Methods\n"; var html = "### Methods\n";
for(method_name in methods){ for(method_name in methods){
var method = methods[method_name]; var method_val = methods[method_name];
html += "- "+method_name+"\n"; html += "- `"+method_name+"`, no details.\n";
} }
return html; return html;
} }
@ -71,8 +71,8 @@ function Docs()
var html = "### Ports\n"; var html = "### Ports\n";
for(port_name in ports){ for(port_name in ports){
var port = ports[setting_name]; var port_val = ports[setting_name];
html += "- "+port_name+"\n"; html += "- `"+port_name+"`, no details.\n";
} }
return html; return html;
} }