Skip to content

Commit 5ecbe38

Browse files
authored
Update README.md
1 parent 159caef commit 5ecbe38

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Sketchy is a framework for making generative art in Go. It is inspired by [vsketch](https://github.com/abey79/vsketch) and [openFrameworks](https://github.com/openframeworks/openFrameworks). It uses [gg](https://github.com/fogleman/gg) for drawing and the [ebiten](https://github.com/hajimehoshi/ebiten) game engine for the GUI. It's designed to provide controls (sliders) via simple JSON that can be used within a familiar `update()` and `draw()` framework to enable quick iteration on designs.
44

5+
The [Getting Started](docs/getting-started.md) is a good place to start, and even walk through creating a "Hello Circle" sketch from scratch.
6+
57
Sketchy is still very much in the alpha stage. Below is an example of what the framework looks like while running the "noise" example.
68

79
![Screenshot_20220216_204611](https://user-images.githubusercontent.com/96601789/154401686-2cf1e26a-e94e-46b5-a022-9002c4b723d5.png)
@@ -72,4 +74,4 @@ The syntax for running a sketch is `sketchy run project_name`. This is just a wr
7274

7375
There are two builtin keyboard shortcuts for saving sketch images and configurations:
7476
- "s" key - saves the current frame as a PNG. The filename has the format `<prefix>_<timestamp>.png`, where `<prefix>` by default is the project name (what you used during `sketchy init project_name`)
75-
- "c" key - saves the configuration (control values and sketch parameters) as JSON. The filename has the format `<prefix>_config_<timestamp>.json`, where `<prefix>` by default is the project name (what you used during `sketchy init project_name`)
77+
- "c" key - saves the configuration (control values and sketch parameters) as JSON. The filename has the format `<prefix>_config_<timestamp>.json`, where `<prefix>` by default is the project name (what you used during `sketchy init project_name`)

0 commit comments

Comments
 (0)