Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jandelgado committed Dec 21, 2018
1 parent 158937f commit ee01bf4
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -389,18 +389,21 @@ the host based provided unit tests [is provided here](test/README.md).
* fork this repository
* create your feature branch
* add code
* add unit test(s)
* add documentation
* make sure linter does not report problems (make lint)
* add [unit test(s)](test/)
* add [documentation](README.md)
* make sure the cpp [linter](https://github.com/cpplint/cpplint) does not
report any problems (run `make lint`). Hint: use `clang-format` with the
provided [settings](.clang-format)
* commit changes
* submit a PR

## FAQ

### How do I check if an JLed object is still being updated?

Check the return value of the `Update()` method: the method returns `true` if
the effect is still running, otherwise `false'.
* Check the return value of the `JLed::Update` method: the method returns `true` if
the effect is still running, otherwise `false`.
* The `JLed::Running` method returns `true` if an effect is running, else `false`.

### How do I restart a effect?

Expand Down

0 comments on commit ee01bf4

Please sign in to comment.