diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 28 |
1 files changed, 26 insertions, 2 deletions
@@ -1,2 +1,26 @@ -# heart -The heart +# 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` + +## Project Status + + |