]> git.r.bdr.sh - rbdr/heart/blob - README.md
4fccd43521af70e863e647c5f8a3489344e46662
[rbdr/heart] / README.md
1 # Heart
2
3 Renders a colorful heart
4
5 ## How to run
6
7 Serve the files in the root directory. For example using: `python -m SimpleHTTPServer`
8
9 ## Setting up
10
11 Though this project is mostly static you should run `yarn install` or
12 `npm install` so you can lint and document the project.
13
14 ## Generating documentation
15
16 1. Run `npm run document`.
17 2. Serve the files that have been generated in the `doc` directory. If
18 already serving the files, just go to `/doc`
19
20 ## Linting
21
22 1. Run `npm lint`
23
24 ## Project Status
25
26 ![Build Status](https://circleci.com/gh/rbdr/heart.png?circle-token=9ffd4c8b8643b95f6d42047b173e2d446d91b32f)