git.r.bdr.sh / rbdr / heart / blame
| Commit | Line | Data |
|---|---|---|
| 910278aa BB |
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` | |
| c2c2772d BB |
23 | |
| 24 | ## Project Status | |
| 25 | ||
| 26 |  |