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

Improved README

Browse Source
This commit is contained in:
Devine Lu Linvega 2019-07-18 09:19:09 +09:00
parent 7890968398
commit bf17394bc4
1 changed files with 74 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
README.md
View File

@ -1,22 +1,89 @@
# Ronin
_All I wanted, was a way of resizing photos._
_"All I wanted, was a quick way of resizing a few photos.."_
Ronin is a LISP repl to create generative graphics currently under development. You can follow the daily progress on [Mastodon](https://merveilles.town/@neauoire/). Until we have documented the library, you can find a list of available functions [here](https://github.com/hundredrabbits/Ronin/blob/master/desktop/sources/scripts/library.js).
Ronin is a [LISP](https://en.wikipedia.org/wiki/Lisp_(programming_language)) repl to create generative graphics currently under development. You can follow the daily progress on [Mastodon](https://merveilles.town/@neauoire/).
<img src='https://raw.githubusercontent.com/hundredrabbits/Ronin/master/PREVIEW.jpg' width='600'/>
## Install & Run
## Electron Build
You can download [builds](https://hundredrabbits.itch.io/ronin) for **OSX, Windows and Linux**, or if you wish to build it yourself, follow these steps:
```
cd desktop
git clone https://github.com/hundredrabbits/Ronin.git
cd Ronin/desktop/
npm install
npm start
```
## Documentation
<img src='https://raw.githubusercontent.com/hundredrabbits/Ronin/master/PREVIEW.jpg' width='600'/>
Documentation is accessible [here](./documentation.md)
## Library
- `(open path)`
- `(export path type quality)`
- `(folder path)` Returns the content of a folder path.
- `(exit force)` Exits Ronin/
- `(add ...args)` Adds values.
- `(sub ...args)` Subtracts values.
- `(mul ...args)` Multiplies values.
- `(div ...args)` Divides values.
- `(mod a b)` Returns the modulo of a and b.
- `(clamp val min max)` Clamps a value between min and max.
- `(step val step)`
- `(min)`
- `(max)`
- `(ceil)`
- `(floor)`
- `(sin)`
- `(cos)`
- `(PI)`
- `(TWO_PI)`
- `(random ...args)`
- `(gt a b)` Returns true if a is greater than b, else false.
- `(lt a b)` Returns true if a is less than b, else false.
- `(eq a b)` Returns true if a is equal to b, else false.
- `(and a b ...rest)` Returns true if all conditions are true.
- `(or a b ...rest)` Returns true if at least one condition is true.
- `(map fn arr)`
- `(filter fn arr)`
- `(reduce fn arr acc)`
- `(len item)` Returns the length of a list.
- `(first arr)` Returns the first item of a list.
- `(last arr)` Returns the last
- `(rest [_ ...arr])`
- `(range start end step)`
- `(pos x y t)` Returns a position shape.
- `(size w h t)` Returns a size shape.
- `(rect x y w h t)` Returns a rect shape.
- `(circle x y r t)` Returns a circle shape.
- `(line a b t)` Returns a line shape.
- `(text x y g s f t)` Returns a text shape.
- `(svg d t)` Returns a svg shape.
- `(frame)` Returns a rect of the frame.
- `(center)` Returns a position of the center of the frame.
- `(scale rect w h)`
- `(clone a b)`
- `(stroke shape)` Strokes a shape.
- `(fill rect)` Fills a shape.
- `(clear rect)` Clears a rect.
- `(get item key)` Gets an object's parameter with name.
- `(set item key val)` Sets an object's parameter with name as value.
- `(of h ...keys)`
- `(theme variable el)`
- `(gradient [x1 y1 x2 y2] colors 'black'])`
- `(draw path rect)`
- `(pixels rect fn q)`
- `(saturation pixel q)`
- `(contrast pixel q)`
- `(resize w h)`
- `(crop rect)`
- `(echo ...args)`
- `(str ...args)`
- `(test name a b)`
- `(ronin)`
- `(time)` Returns timestamp in milliseconds.
- `(animate play)` Toggles animation.
- `(js)`
## Extras