aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSelene ToyKeeper2023-11-05 11:51:17 -0700
committerSelene ToyKeeper2023-11-05 11:51:17 -0700
commitc809a04bf378124cedfb5606ede2fa29862c8d5c (patch)
treeb67f15e8f7ccf8d1f667715aa1145ab554232fc4 /README.md
parentdetect-mcu.sh: don't hang when MCU isn't found; exit with an error instead (diff)
downloadanduril-c809a04bf378124cedfb5606ede2fa29862c8d5c.tar.gz
anduril-c809a04bf378124cedfb5606ede2fa29862c8d5c.tar.bz2
anduril-c809a04bf378124cedfb5606ede2fa29862c8d5c.zip
docs: added info on contributing, fixed minor formatting issues
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
index 4bad7ad..ba0786e 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,7 @@ you like, such as "Flashlight" or whatever suits your mood. FSM also means
"Finite State Machine", which is the type of abstraction used for defining user
interfaces. It is like a flowchart turned into executable code.
+
## Using Anduril
Anduril has many features, but the only things a person *really* needs to know
@@ -25,6 +26,7 @@ For info about hardware-specific features, like what the channel modes are on
multi-channel lights, browse into the [hw/](hw/) directories to find the
hardware model and any hardware-specific documentation.
+
## Flashing Firmware
Get the latest updates by flashing new firmware!
@@ -57,6 +59,7 @@ One particularly useful guide is at https://anduril.click/ .
More info about installing flashing programs is below, in
[Flashing Programs](#flashing-programs).
+
## Compiling
The firmware can be deeply customized by modifying it and compiling your own
@@ -91,6 +94,7 @@ firmwares for Hanklights with optional boost drivers.
The compiled firmware goes into the `hex/` directory, ready to be used by any
firmware flashing program.
+
## Customizing Settings Per User
The build can be [customized per user](docs/per-user-config.md) by placing
@@ -98,6 +102,7 @@ overrides into the `users/myname/` directory and letting the build script know
your username. That way, your favorite settings can be applied automatically
without having to modify the original source files.
+
## Flashing Programs
### AVRdude
@@ -121,3 +126,21 @@ You'll need to `source env/bin/activate` every time you start a fresh shell,
if you want to use pymcuprog. The activation lasts until the shell is
closed or until you run `deactivate`.
+
+## Contributing
+
+If you'd like to help, there are several ways...
+
+ - ToyKeeper has a [Patreon site](https://patreon.com/ToyKeeper) for
+ donations, to help figuratively and literally keep the lights on.
+
+ - Send pull requests or patches, to improve things directly. These can be
+ code, documentation, tools, or anything you think is useful.
+
+ - File bug reports for any problems you find.
+
+ - Answer people's questions on public forums. If the same questions come up
+ a lot, consider adding it to the documentation here.
+
+ - Ask manufacturers to use this firmware, and to support its development.
+