mirror of
https://github.com/rough-stuff/rough.git
synced 2026-02-15 07:55:38 -05:00
50 lines
1.7 KiB
Markdown
50 lines
1.7 KiB
Markdown
# Rough.js
|
||
|
||
This is a light weight [Canvas](https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API) based library that lets you draw in a _sketchy_, _hand-drawn-like_, style.
|
||
|
||
The library defines primitives to draw lines, curves, arcs, polygons, circles, and ellipses. It also supports drawing [SVG paths](https://developer.mozilla.org/en-US/docs/Web/SVG/Tutorial/Paths).
|
||
|
||
This project was inspired by [Handy](http://www.gicentre.net/handy/), a java based library for [Processing](https://processing.org/).
|
||
Rough.js borrows some core algorithms from Handy, but it is _not a JS port_ for processing.js.
|
||
|
||
## Releases
|
||
|
||
The latest Rough.js release (beta version 0.1): [Download](./rough.zip)
|
||
|
||
# How to use Rough.js
|
||
## Setup
|
||
Initialize a **RoughCanvas** object by passing in the canvas node and the size of the canvas.
|
||
Following code snippet draws a rectangle.
|
||
|
||
### Markdown
|
||
|
||
Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for
|
||
|
||
```markdown
|
||
Syntax highlighted code block
|
||
|
||
# Header 1
|
||
## Header 2
|
||
### Header 3
|
||
|
||
- Bulleted
|
||
- List
|
||
|
||
1. Numbered
|
||
2. List
|
||
|
||
**Bold** and _Italic_ and `Code` text
|
||
|
||
[Link](url) and 
|
||
```
|
||
|
||
For more details see [GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/).
|
||
|
||
### Jekyll Themes
|
||
|
||
Your Pages site will use the layout and styles from the Jekyll theme you have selected in your [repository settings](https://github.com/pshihn/rough/settings). The name of this theme is saved in the Jekyll `_config.yml` configuration file.
|
||
|
||
### Support or Contact
|
||
|
||
Having trouble with Pages? Check out our [documentation](https://help.github.com/categories/github-pages-basics/) or [contact support](https://github.com/contact) and we’ll help you sort it out.
|