From 910278aad4a0b47dc40112839a18bc8e590302e5 Mon Sep 17 00:00:00 2001 From: Ben Beltran Date: Wed, 9 Nov 2016 23:41:37 -0600 Subject: Add basic animator project --- README.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index e55907e..6238f46 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,22 @@ -# 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` -- cgit From c2c2772d0ed568c5992473893254ad31e09792e5 Mon Sep 17 00:00:00 2001 From: Ben Beltran Date: Wed, 9 Nov 2016 23:46:03 -0600 Subject: Add CI status to README --- README.md | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 6238f46..4fccd43 100644 --- a/README.md +++ b/README.md @@ -20,3 +20,7 @@ Though this project is mostly static you should run `yarn install` or ## Linting 1. Run `npm lint` + +## Project Status + +![Build Status](https://circleci.com/gh/rbdr/heart.png?circle-token=9ffd4c8b8643b95f6d42047b173e2d446d91b32f) -- cgit