blob: 6238f4662597d9834aa70f4412e61930a625300a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
|
# Heart
Renders a colorful heart
## How to run
Serve the files in the root directory. For example using: `python -m SimpleHTTPServer`
## Setting up
Though this project is mostly static you should run `yarn install` or
`npm install` so you can lint and document the project.
## Generating documentation
1. Run `npm run document`.
2. Serve the files that have been generated in the `doc` directory. If
already serving the files, just go to `/doc`
## Linting
1. Run `npm lint`
|