aboutsummaryrefslogtreecommitdiff
path: root/docs/source
AgeCommit message (Collapse)Author
2011-06-11Remove reST documentation, attendant updates.Marti Bolivar
The documentation covers topics not specifically relevant to libmaple, so it doesn't make sense for it to be part of the libmaple source distribution. Delete the docs/ tree, and prepare libmaple for use with the new leaflabs-docs repo, which will contain the docs from now on. * README: update to reflect this change * support/doxygen/Doxyfile: This is the old docs/Doxyfile * Makefile: Add a doxygen target * wirish/comm/HardwareSerial.h: fix reference to docs/. The comment informing maintainers that the HardwareSerial interface is documented by hand refers to the docs/ tree, which no longer exists. Update it to refer to the separate leaflabs-docs repository. * support/scripts/copy-to-ide: No longer build the documentation
2011-06-10Docs: Add GPIO port pin maps.Marti Bolivar
2011-06-10Docs: Update quickstart for Mini.Marti Bolivar
2011-06-10Docs: Update "my board is bricked!" troubleshooting item.Marti Bolivar
2011-06-10Docs: move ASSERT() to its own page.Marti Bolivar
ASSERT() was previously documented in language.rst. Move it to a new lang/api/assert.rst.
2011-06-10Docs: Generalize throb()-related troubleshooting item.Marti Bolivar
The FAQ entry which explains the throbbing LED behavior is insufficiently general. Rewrite it so users can tell that throbbing generally indicates a failed assertion or some other error.
2011-06-10Docs: Use "BOARD_LED_PIN" instead of "13".Marti Bolivar
Fix examples where pin 13 was used explicitly instead of BOARD_LED_PIN. Also change an AVR-specific example in docs/lang/cpp/booleanvariables.rst to Maple conventions.
2011-06-06Docs: add note on adding self to plugdev group.Marti Bolivar
Thanks to forum user AndyH for the suggestion.
2011-06-03Docs: Correct "Github" -> "GitHub"Marti Bolivar
2011-06-03Docs: Various tweaks and fixups.Marti Bolivar
Thanks to forum user AndyH for the corrections.
2011-06-01Docs: Update release FIXMEs for 0.0.12.Marti Bolivar
This is a pretty brain-dead way to manage these pre-release preparations. Should figure out the done thing and use that instead.
2011-05-28Docs: Tweak disabling JTAG debugging information.Marti Bolivar
2011-05-28Docs: Simplify and clarify usart.rst.Marti Bolivar
Make the language a little friendlier, say the words "serial port", and let them know that baud rate is a speed.
2011-05-28Docs: Improve analogwrite.rst.Marti Bolivar
Make the note warning against its usage more direct. Add a blurb introducing its purpose and links in See Also to related board-specific values.
2011-05-27Docs: Improve i2c.rst.Marti Bolivar
Slightly reorganize to keep it consistent with the rest of the docs.
2011-05-27Docs: Improve external-interrupts.rst.Marti Bolivar
Make the language friendlier; point to GPIO port definition for an explanation of the EXTI line definition.
2011-05-27Docs: Making boards pages point to "5V tolerant" definition.Marti Bolivar
2011-05-27Docs: Update gpio.rst.Marti Bolivar
Add a section about GPIO ports, since that existed nowhere. Made a ref for 5V tolerance. Other clarifications and improvements.
2011-05-27Docs: Updating pinmode.rstMarti Bolivar
Convert to board-specific values; make the language friendlier.
2011-05-27Docs: Correct i2c.rst errors.Marti Bolivar
10-bit addressing has now been implemented. Slave mode is unimplemented, however.
2011-05-27Docs: Fix implication that Maple Rev 1 didn't have a battery charger.Marti Bolivar
It did, but there was no jumper to cut power from the charging circuit, resulting in weird blinky behavior that was fixed in Rev 3.
2011-05-27Docs: Include D3 in low-noise analog pins on Mini.Marti Bolivar
2011-05-27Docs: Fix ADC voltage source error.Marti Bolivar
Vdda, not Vcc.
2011-05-26Fix millis() example.Marti Bolivar
2011-05-26Docs: board-values.rst touchup.Marti Bolivar
2011-05-26Make docs say their version is 'custom-build'.Marti Bolivar
This should get changed on each release branch when the time comes. A FIXME comment has been added to that effect.
2011-05-26Docs: Move toggleLED() and waitForButtonPress() examples.Marti Bolivar
These two examples from board-values.rst really belong in the documentation for the functions they reference.
2011-05-26Docs: Add Maple Mini informationMarti Bolivar
Flesh out and uncomment maple-mini.rst. Add links to pieces of it in various appropriate places throughout the rest of the documentation.
2011-05-26Docs: fix and standardize Maple and RET6 hardware pages.Marti Bolivar
Pick a standard layout for the information and fix mistakes. Looks like some of these errors were copy-pasted in from the old HTML documentation, some crept in due to API changes, and some were just wrong. I've checked all the claims against the datasheets and source code, so we should be in good shape now.
2011-05-26Docs: lang/api/constants.rst touchupsMarti Bolivar
Mostly, make it less pedantic. Also some stylistic and content fixes.
2011-05-26Docs: troubleshooting.rst touchupsMarti Bolivar
2011-05-26Docs: libmaple overview.rst fixes.Marti Bolivar
2011-05-26Docs: maple-ret6.rst touchups.Marti Bolivar
2011-05-23Generifying maple-ide-install.rst.Marti Bolivar
In line with some changes made earlier today to the maple-ide repo, the master libmaple branch no longer points to a particular IDE release as "current", since there's no way it can know. From now on, only release branches will contain the blessed download links.
2011-05-23RET6 Edition docs typo.Marti Bolivar
2011-05-23Servo docs fixups.Marti Bolivar
2011-05-230.0.10 docs RCMarti Bolivar
2011-05-23analogWrite() docs typoMarti Bolivar
2011-05-17Docs: removing reference to String class.Marti Bolivar
2011-05-17Docs: fixing tar invocation in Unix toolchain quickstart.Marti Bolivar
2011-05-14Docs: Removing first person ("I'll") usage.Marti Bolivar
2011-05-13Docs: whitespace fascism.Marti Bolivar
2011-05-13Docs: Various improvements.Marti Bolivar
2011-05-13Docs: Updating Servo docs.Marti Bolivar
2011-05-13Docs: correcting "Github" -> "GitHub".Marti Bolivar
2011-05-13Docs: board-specific values for Maple and Maple RET6 Edition.Marti Bolivar
2011-05-13Docs: More complete board-specific values list.Marti Bolivar
2011-05-13Docs: Removing note about cutting the Maple's NJTRST<->NRST trace.Marti Bolivar
Worried about the possibility of an attractive nuisance.
2011-05-13Docs: Adding "standby" to low-power marketing.Marti Bolivar
2011-05-13Docs: Fixing power supply marketing mistake.Marti Bolivar