Skip to content

Commit 535b82e

Browse files
Improve README.md
1 parent 12b6526 commit 535b82e

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,20 @@ Usage is simple: RGB-OS defines a series of patterns. These are classes, derived
44
Upon calling the function `next_frame()` the class will write the next frame to the neopixels (passed into the class upon `__init__()`)
55
The `main.py` file first makes a list of the animations, and starts playing the first one. If you press the button
66
(defined in `main.py`), it stops playing the first animation, and moves on to the next. Pressing it again will play the third.
7+
If you diddn't understand that, don't worry. Move on to the usage section below, for how to get started.
78

89
## Usage
910
To use, first install circuitpython on a microcontroller, and attatch neopixels. Then, erase all of the files on the
1011
microcontroller, and replace with the files in this repo (even the `lib` folder). Then, open `main.py` in a text editor,
11-
and follow the steps detailed in the file.
12+
and follow the steps detailed in the file. (It's super easy!!)
13+
14+
After that, should have changed everything necesarry to make it work!
15+
16+
## Contributing
17+
### New features
18+
If you have made changes to the program for your own use, that makes it better, please put it in a pull request!
19+
It is relatively easy to make new animations - look at the animations in the patterns folder. If you make any, please Pull Request them!
20+
21+
### Bugs or Spelling Mistakes
22+
If there are, heavens forbid, any bugs, spelling mistakes, missing bits of documentation, or problems with documentation,
23+
please put it in an issue, or, fix it yourself and put it in a Pull Request!

0 commit comments

Comments
 (0)