alpha
/
Kaleidoscope
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Working toward being able to have a coherent organization of our docs

Browse Source
pull/859/head
Jesse Vincent 5 years ago
parent d7e0f49fef
commit 2c9d3747ec
No known key found for this signature in database
GPG Key ID: CC228463465E40BC
9 changed files with 2656 additions and 106 deletions
Show Stats Download Patch File Download Diff File

2553
docs/Doxyfile
View File

File diff suppressed because it is too large Load Diff

44
docs/NEWS.md
Unescape View File

@ -74,23 +74,23 @@ See the [Kaleidoscope-USB-Quirks][plugin:USB-Quirks] plugin for a use-case.
### Finer stickability controls for OneShot ### Finer stickability controls for OneShot
The [OneShot plugin](doc/plugin/OneShot.md) gained finer stickability controls, one can now control whether the double-tap stickiness is enabled on a per-key basis. See [UPGRADING.md](UPGRADING.md#finer-oneshot-stickability-control) for more information. The [OneShot plugin](plugins/OneShot.md) gained finer stickability controls, one can now control whether the double-tap stickiness is enabled on a per-key basis. See [UPGRADING.md](UPGRADING.md#finer-oneshot-stickability-control) for more information.
### A way to slow down Unicode input ### A way to slow down Unicode input
In certain cases we need to delay the unicode input sequence, otherwise the host is unable to process the input properly. For this reason, the [Unicode](doc/plugin/Unicode.md) gained an `.input_delay()` method that lets us do just that. It still defaults to no delay. In certain cases we need to delay the unicode input sequence, otherwise the host is unable to process the input properly. For this reason, the [Unicode](plugins/Unicode.md) gained an `.input_delay()` method that lets us do just that. It still defaults to no delay.
### Better support for modifiers in the Cycle plugin ### Better support for modifiers in the Cycle plugin
The [Cycle](doc/plugin/Cycle.md) plugin has much better support for cycling through keys with modifiers applied to them, such as `LSHIFT(Key_A)`. Please see the documentation and the updated example for more information. The [Cycle](plugins/Cycle.md) plugin has much better support for cycling through keys with modifiers applied to them, such as `LSHIFT(Key_A)`. Please see the documentation and the updated example for more information.
### More control over when to send reports during Macro playback ### More control over when to send reports during Macro playback
There are situations where one would like to disable sending a report after each and every step of a macro, and rather have direct control over when reports are sent. The new `WITH_EXPLICIT_REPORT`, `WITH_IMPLICIT_REPORT` and `SEND_REPORT` steps help with that. Please see the [Macros](doc/plugin/Macros.md) documentation for more information. There are situations where one would like to disable sending a report after each and every step of a macro, and rather have direct control over when reports are sent. The new `WITH_EXPLICIT_REPORT`, `WITH_IMPLICIT_REPORT` and `SEND_REPORT` steps help with that. Please see the [Macros](plugins/Macros.md) documentation for more information.
### LED-ActiveModColor can be asked to not highlight normal modifiers ### LED-ActiveModColor can be asked to not highlight normal modifiers
The plugin was intended to work with OneShot primarily, and that's where it is most useful. To make it less surprising, and more suitable to include it in default-like firmware, we made it possible to ask it not to highlight normal modifiers. Please see the [LED-ActiveModColor](doc/plugin/LED-ActiveModColor.md) documentation for more information. The plugin was intended to work with OneShot primarily, and that's where it is most useful. To make it less surprising, and more suitable to include it in default-like firmware, we made it possible to ask it not to highlight normal modifiers. Please see the [LED-ActiveModColor](plugins/LED-ActiveModColor.md) documentation for more information.
### Events now trigger on layer changes ### Events now trigger on layer changes
@ -113,46 +113,46 @@ New `PER_KEY_DATA` and `PER_KEY_DATA_STACKED` macros are available (when defined
Kaleidoscope has been ported to the following devices: Kaleidoscope has been ported to the following devices:
- [Atreus](doc/plugin/Hardware-Technomancy-Atreus.md): All known variants of the original Atreus are supported. From the Legacy Teensy variant, through the pre-2016 PCB with an A* MCU, the post-2016 PCB, and FalbaTech's handwired one too. Apart from the legacy Teensy variant, the other support both the A* or a Teensy as an MCU. - [Atreus](hardware-devices/Hardware-Technomancy-Atreus.md): All known variants of the original Atreus are supported. From the Legacy Teensy variant, through the pre-2016 PCB with an A* MCU, the post-2016 PCB, and FalbaTech's handwired one too. Apart from the legacy Teensy variant, the other support both the A* or a Teensy as an MCU.
- [ErgoDox](doc/plugin/Hardware-EZ-ErgoDox.md): Originally developed to support the ErgoDox EZ, but all other compatible hardware is supported, such as the original ErgoDox and anything else wired like it, like some Dactyls. - [ErgoDox](hardware-devices/Hardware-EZ-ErgoDox.md): Originally developed to support the ErgoDox EZ, but all other compatible hardware is supported, such as the original ErgoDox and anything else wired like it, like some Dactyls.
- [Planck](doc/plugin/Hardware-OLKB-Planck.md): AVR-based Plancks, and anything else wired similarly should be supported, as long as they use a Teensy. - [Planck](hardware-devices/Hardware-OLKB-Planck.md): AVR-based Plancks, and anything else wired similarly should be supported, as long as they use a Teensy.
- [Splitography](doc/plugin/Hardware-SOFTHRUF-Splitography.md): Initial support for the Splitography Steno keyboard. - [Splitography](hardware-devices/Hardware-SOFTHRUF-Splitography.md): Initial support for the Splitography Steno keyboard.
For more information, please see the hardware plugins' documentation. For more information, please see the hardware plugins' documentation.
To make it easier to port Kaleidoscope, we introduced the [ATMegaKeyboard](doc/plugin/ATMegaKeyboard.md) base class. For any board that's based on the ATMega MCU and a simple matrix, this might be a good foundation to develop the hardware plugin upon. To make it easier to port Kaleidoscope, we introduced the [ATMegaKeyboard](plugins/ATMegaKeyboard.md) base class. For any board that's based on the ATMega MCU and a simple matrix, this might be a good foundation to develop the hardware plugin upon.
## New plugins ## New plugins
### DynamicMacros ### DynamicMacros
The [DynamicMacros](doc/plugin/DynamicMacros.md) plugin provides a way to use and update macros via the Focus API, through Chrysalis. The [DynamicMacros](plugins/DynamicMacros.md) plugin provides a way to use and update macros via the Focus API, through Chrysalis.
### IdleLEDs ### IdleLEDs
The [IdleLEDs](doc/plugin/IdleLEDs.md) plugin is a simple, yet, useful one: it will turn the keyboard LEDs off after a period of inactivity, and back on upon the next key event. The [IdleLEDs](plugins/IdleLEDs.md) plugin is a simple, yet, useful one: it will turn the keyboard LEDs off after a period of inactivity, and back on upon the next key event.
### LEDActiveLayerColor ### LEDActiveLayerColor
The [LEDActiveLayerColor][doc/plugin/LEDActiveLayerColor.md] plugin makes it possible to set the color of all LEDs to the same color, depending on which layer is active topmost. The [LEDActiveLayerColor][plugins/LEDActiveLayerColor.md] plugin makes it possible to set the color of all LEDs to the same color, depending on which layer is active topmost.
### LED-Wavepool ### LED-Wavepool
We integrated the [LEDWavepool](doc/plugin/LED-Wavepool.md) plugin by [ToyKeeper][wavepool:origin], with a few updates and new features added. We integrated the [LEDWavepool](plugins/LED-Wavepool.md) plugin by [ToyKeeper][wavepool:origin], with a few updates and new features added.
[wavepool:origin]: https://github.com/ToyKeeper/Kaleidoscope-LED-Wavepool [wavepool:origin]: https://github.com/ToyKeeper/Kaleidoscope-LED-Wavepool
### Turbo ### Turbo
The [Turbo](doc/plugin/Turbo.md) plugin provides a way to send keystrokes in very quick succession while holding down a key. The [Turbo](plugins/Turbo.md) plugin provides a way to send keystrokes in very quick succession while holding down a key.
### WinKeyToggle ### WinKeyToggle
The [WinKeyToggle](doc/plugin/WinKeyToggle.md) plugin assists with toggling the Windows key on and off - a little something for those of us who game under Windows and are tired of accidentally popping up the start menu. The [WinKeyToggle](plugins/WinKeyToggle.md) plugin assists with toggling the Windows key on and off - a little something for those of us who game under Windows and are tired of accidentally popping up the start menu.
### FirmwareDump ### FirmwareDump
The [FirmwareDump](doc/plugin/FirmwareDump.md) plugin makes it possible to dump one's firmware over Focus. The [FirmwareDump](plugins/FirmwareDump.md) plugin makes it possible to dump one's firmware over Focus.
## Breaking changes ## Breaking changes
@ -185,29 +185,29 @@ The `NumPad` plugin used to toggle `NumLock` when switching to the NumPad layer.
### The `RxCy` macros and peeking into the keyswitch state ### The `RxCy` macros and peeking into the keyswitch state
The `RxCy` macros changed from being indexes into a per-hand bitmap to being an index across the whole keyboard. This mostly affected the [MagicCombo](doc/plugin/MagicCombo.md) plugin. The `RxCy` macros changed from being indexes into a per-hand bitmap to being an index across the whole keyboard. This mostly affected the [MagicCombo](plugins/MagicCombo.md) plugin.
Please see the [relevant upgrade notes](UPGRADING.md#the-rxcy-macros-and-peeking-into-the-keyswitch-state) for more information. Please see the [relevant upgrade notes](UPGRADING.md#the-rxcy-macros-and-peeking-into-the-keyswitch-state) for more information.
### The `Redial` plugin had a breaking API change ### The `Redial` plugin had a breaking API change
The [Redial](doc/plugin/Redial.md) plugin was simplified, one no longer needs to define `Key_Redial` on their own, the plugin defines it itself. See the [upgrade notes](UPGRADING.md#Redial) for more information about how to upgrade. The [Redial](plugins/Redial.md) plugin was simplified, one no longer needs to define `Key_Redial` on their own, the plugin defines it itself. See the [upgrade notes](UPGRADING.md#Redial) for more information about how to upgrade.
### Color palette storage has changed ### Color palette storage has changed
The [LED-Palette-Theme](doc/plugin/LED-Palette-Theme.md) had to be changed to store the palette colors in reverse. This change had to be made in order to not default to a bright white palette, that would draw so much power that most operating systems would disconnect the keyboard due to excessive power usage. With inverting the colors, we now default to a black palette instead. This sadly breaks existing palettes, and you will have to re-set the colors. The [LED-Palette-Theme](plugins/LED-Palette-Theme.md) had to be changed to store the palette colors in reverse. This change had to be made in order to not default to a bright white palette, that would draw so much power that most operating systems would disconnect the keyboard due to excessive power usage. With inverting the colors, we now default to a black palette instead. This sadly breaks existing palettes, and you will have to re-set the colors.
We also changed when we reserve space for the palette in EEPROM: we used to do it as soon as possible, but that made it impossible to go from a firmware that does not use the plugin to one that does, and still have a compatible EEPROM layout. We now reserve space as late as possible. This breaks existing EEPROM layouts however. We also changed when we reserve space for the palette in EEPROM: we used to do it as soon as possible, but that made it impossible to go from a firmware that does not use the plugin to one that does, and still have a compatible EEPROM layout. We now reserve space as late as possible. This breaks existing EEPROM layouts however.
### EEPROM-Keymap changed Focus commands ### EEPROM-Keymap changed Focus commands
The [EEPROMKeymap](doc/plugin/EEPROM-Keymap.md) plugin was changed to treat built-in (default) and EEPROM-stored (custom) layers separately, because that's less surprising, and easier to work with from Chrysalis. The old `keymap.map` and `keymap.roLayers` commands are gone, the new `keymap.default` and `keymap.custom` commands should be used instead. The [EEPROMKeymap](plugins/EEPROM-Keymap.md) plugin was changed to treat built-in (default) and EEPROM-stored (custom) layers separately, because that's less surprising, and easier to work with from Chrysalis. The old `keymap.map` and `keymap.roLayers` commands are gone, the new `keymap.default` and `keymap.custom` commands should be used instead.
### EEPROMSettings' version() setter has been deprecated ### EEPROMSettings' version() setter has been deprecated
We're repurposing the `version` setting: instead of it being something end-users We're repurposing the `version` setting: instead of it being something end-users
can set, we'll be using it internally to track changes made to can set, we'll be using it internally to track changes made to
[EEPROMSettings](doc/plugin/EEPROM-Settings.md) itself, with the goal of [EEPROMSettings](plugins/EEPROM-Settings.md) itself, with the goal of
allowing external tools to aid in migrations. The setting wasn't widely used - allowing external tools to aid in migrations. The setting wasn't widely used -
if at all -, which is why we chose to repurpose it instead of adding a new if at all -, which is why we chose to repurpose it instead of adding a new
field. field.

26
docs/UPGRADING.md
Unescape View File

@ -433,7 +433,7 @@ The new API is much shorter, and is inspired by the way the [Leader][leader]
plugin works: instead of having a list, and a dispatching function like plugin works: instead of having a list, and a dispatching function like
`magicComboActions`, we include the action method in the list too! `magicComboActions`, we include the action method in the list too!
[leader]: doc/plugin/Leader.md [leader]: plugins/Leader.md
We also don't make a difference between left- and right-hand anymore, you can We also don't make a difference between left- and right-hand anymore, you can
just list keys for either in the same list. This will be very handy for just list keys for either in the same list. This will be very handy for
@ -500,19 +500,19 @@ With the move towards a monorepo-based source, some headers have moved to a new
The following headers and names have changed: The following headers and names have changed:
- `layers.h`, `key_defs_keymaps.h` and `macro_helpers.h` are obsolete, and should not be included in the first place, as `Kaleidoscope.h` will pull them in. In the rare case that one needs them, prefixing them with `kaleidoscope/` is the way to go. Of the various headers provided under the `kaleidoscope/` space, only `kaleidoscope/macro_helpers.h` should be included directly, and only by hardware plugins that can't pull `Kaleidoscope.h` in due to circular dependencies. - `layers.h`, `key_defs_keymaps.h` and `macro_helpers.h` are obsolete, and should not be included in the first place, as `Kaleidoscope.h` will pull them in. In the rare case that one needs them, prefixing them with `kaleidoscope/` is the way to go. Of the various headers provided under the `kaleidoscope/` space, only `kaleidoscope/macro_helpers.h` should be included directly, and only by hardware plugins that can't pull `Kaleidoscope.h` in due to circular dependencies.
- `LED-Off.h`, provided by [LEDControl](doc/plugin/LEDControl.md) is obsolete, the `LEDOff` LED mode is automatically provided by `Kaleidoscope-LEDControl.h`. The `LED-Off.h` includes can be safely removed. - `LED-Off.h`, provided by [LEDControl](plugins/LEDControl.md) is obsolete, the `LEDOff` LED mode is automatically provided by `Kaleidoscope-LEDControl.h`. The `LED-Off.h` includes can be safely removed.
- `LEDUtils.h` is automatically pulled in by `Kaleiodscope-LEDControl.h`, too, and there's no need to directly include it anymore. - `LEDUtils.h` is automatically pulled in by `Kaleiodscope-LEDControl.h`, too, and there's no need to directly include it anymore.
- Plugins that implement LED modes should subclass `kaleidoscope::plugin::LEDMode` instead of `kaleidoscope::LEDMode`. - Plugins that implement LED modes should subclass `kaleidoscope::plugin::LEDMode` instead of `kaleidoscope::LEDMode`.
- [GhostInTheFirmware](doc/plugin/GhostInTheFirmware.md) had the `kaleidoscope::GhostInTheFirmware::GhostKey` type replaced by `kaleidoscope::plugin::GhostInTheFirmware::GhostKey`. - [GhostInTheFirmware](plugins/GhostInTheFirmware.md) had the `kaleidoscope::GhostInTheFirmware::GhostKey` type replaced by `kaleidoscope::plugin::GhostInTheFirmware::GhostKey`.
- [HostOS](doc/plugin/HostOS.md) no longer provides the `Kaleidoscope/HostOS-select.h` header, and there is no backwards compatibility header either. - [HostOS](plugins/HostOS.md) no longer provides the `Kaleidoscope/HostOS-select.h` header, and there is no backwards compatibility header either.
- [Leader](doc/plugin/Leader.md) had the `kaleidoscope::Leader::dictionary_t` type replaced by `kaleidoscope::plugin::Leader::dictionary_t`. - [Leader](plugins/Leader.md) had the `kaleidoscope::Leader::dictionary_t` type replaced by `kaleidoscope::plugin::Leader::dictionary_t`.
- [LED-AlphaSquare](doc/plugin/LED-AlphaSquare.md) used to provide extra symbol graphics in the `kaleidoscope::alpha_square::symbols` namespace. This is now replaced by `kaleidoscope::plugin::alpha_square::symbols`. - [LED-AlphaSquare](plugins/LED-AlphaSquare.md) used to provide extra symbol graphics in the `kaleidoscope::alpha_square::symbols` namespace. This is now replaced by `kaleidoscope::plugin::alpha_square::symbols`.
- [LEDEffect-SolidColor](doc/plugin/LEDEffect-SolidColor.md) replaced the base class - `kaleidoscope::LEDSolidColor` - with `kaleidoscope::plugin::LEDSolidColor`. - [LEDEffect-SolidColor](plugins/LEDEffect-SolidColor.md) replaced the base class - `kaleidoscope::LEDSolidColor` - with `kaleidoscope::plugin::LEDSolidColor`.
- [Qukeys](doc/plugin/Qukeys.md) had the `kaleidoscope::Qukey` type replaced by `kaleidoscope::plugin::Qukey`. - [Qukeys](plugins/Qukeys.md) had the `kaleidoscope::Qukey` type replaced by `kaleidoscope::plugin::Qukey`.
- [ShapeShifter](doc/plugin/ShateShifter.md) had the `kaleidoscope::ShapeShifter::dictionary_t` type replaced by `kaleidoscope::plugin::ShapeShifter::dictionary_t`. - [ShapeShifter](plugins/ShateShifter.md) had the `kaleidoscope::ShapeShifter::dictionary_t` type replaced by `kaleidoscope::plugin::ShapeShifter::dictionary_t`.
- [SpaceCadet](doc/plugin/SpaceCadet.md) had the `kaleidoscope::SpaceCadet::KeyBinding` type replaced by `kaleidoscope::plugin::SpaceCadet::KeyBinding`. - [SpaceCadet](plugins/SpaceCadet.md) had the `kaleidoscope::SpaceCadet::KeyBinding` type replaced by `kaleidoscope::plugin::SpaceCadet::KeyBinding`.
- [Syster](doc/plugin/Syster.md) had the `kaleidoscope::Syster::action_t` type replaced by `kaleidoscope::plugin::Syster::action_t`. - [Syster](plugins/Syster.md) had the `kaleidoscope::Syster::action_t` type replaced by `kaleidoscope::plugin::Syster::action_t`.
- [TapDance](doc/plugin/TapDance.md) had the `kaleidoscope::TapDance::ActionType` type replaced by `kaleidoscope::plugin::TapDance::ActionType`. - [TapDance](plugins/TapDance.md) had the `kaleidoscope::TapDance::ActionType` type replaced by `kaleidoscope::plugin::TapDance::ActionType`.
# Removed APIs # Removed APIs
@ -583,7 +583,7 @@ The deprecated row/col based indexing APIs have been removed on **2020-06-16**.
#### EEPROMKeymap mode #### EEPROMKeymap mode
The [EEPROM-Keymap](doc/plugin/EEPROM-Keymap.md) plugin had its `setup()` method changed, the formerly optional `method` argument is now obsolete and unused. It can be safely removed. The [EEPROM-Keymap](plugins/EEPROM-Keymap.md) plugin had its `setup()` method changed, the formerly optional `method` argument is now obsolete and unused. It can be safely removed.
##### keymaps array and KEYMAPS and KEYMAPS_STACKED macros ##### keymaps array and KEYMAPS and KEYMAPS_STACKED macros

BIN
docs/_sphinx/__pycache__/copy-examples.cpython-37.pyc
View File

Binary file not shown.

28
docs/conf.py
Unescape View File

@ -32,8 +32,8 @@ author = 'Keyboardio & Friends'
extensions = [ extensions = [
#'breathe', #'breathe',
#'exhale', #'exhale',
'recommonmark' 'recommonmark',
'sphinx_markdown_tables'
] ]
extensions.append('copy-examples') extensions.append('copy-examples')
@ -56,11 +56,11 @@ exhale_args = {
"rootFileTitle": "Kaleidoscope", "rootFileTitle": "Kaleidoscope",
"doxygenStripFromPath": "..", "doxygenStripFromPath": "..",
# Suggested optional arguments # Suggested optional arguments
"createTreeView": False, "createTreeView": True,
# TIP: if using the sphinx-bootstrap-theme, you need # TIP: if using the sphinx-bootstrap-theme, you need
# "treeViewIsBootstrap": True, # "treeViewIsBootstrap": True,
"exhaleExecutesDoxygen": True, "exhaleExecutesDoxygen": True,
"exhaleDoxygenStdin": "INPUT = ../src", "exhaleUseDoxyfile": True,
"verboseBuild": True "verboseBuild": True
} }
@ -70,6 +70,10 @@ primary_domain = 'cpp'
# Tell sphinx what the pygments highlight language should be. # Tell sphinx what the pygments highlight language should be.
highlight_language = 'cpp' highlight_language = 'cpp'
cpp_id_attributes = ["aligned","packed","weak","always_inline","noinline","no-unroll-loops","__attribute__((optimize(3)))"]
cpp_paren_attributes = ["optimize","__aligned__","section","deprecated"]
source_suffix = { source_suffix = {
'.rst': 'restructuredtext', '.rst': 'restructuredtext',
'.txt': 'restructuredtext', '.txt': 'restructuredtext',
@ -91,6 +95,22 @@ exclude_patterns = ['_build', '_sphinx', 'Thumbs.db', '.DS_Store', 'etc', 'requi
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
html_theme_options = {
'logo_only': False,
'display_version': True,
'prev_next_buttons_location': 'bottom',
'style_external_links': False,
'vcs_pageview_mode': '',
'style_nav_header_background': 'white',
# Toc options
'collapse_navigation': True,
'sticky_navigation': True,
'navigation_depth': 8,
'includehidden': False,
'titles_only': True
}
# #
# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org # on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org

4
docs/examples.rst
Unescape View File

@ -6,8 +6,8 @@
All example sketches All example sketches
==================== ====================
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 8
:glob: :glob:
examples/**/*.ino generated/examples/**/*.ino

77
docs/index.rst
Unescape View File

@ -13,119 +13,86 @@ This package contains the "core" of Kaleidoscope and a number of [example firmwa
If you're just getting started with the Keyboardio Model 01, the [introductory docs are here](https://github.com/keyboardio/Kaleidoscope/wiki/Keyboardio-Model-01-Introduction) and the source for the basic firmware package is here: https://github.com/keyboardio/Model01-Firmware. It's probably a good idea to start there, learn how to modify your keymap and maybe turn some modules on or off, and then come back to the full repository when you have more complex changes in mind. If you're just getting started with the Keyboardio Model 01, the [introductory docs are here](https://github.com/keyboardio/Kaleidoscope/wiki/Keyboardio-Model-01-Introduction) and the source for the basic firmware package is here: https://github.com/keyboardio/Model01-Firmware. It's probably a good idea to start there, learn how to modify your keymap and maybe turn some modules on or off, and then come back to the full repository when you have more complex changes in mind.
Installation and setup
======================
.. toctree:: .. toctree::
:caption: Installation and setup
:maxdepth: 2 :maxdepth: 2
quick_start quick_start
setup_toolchain
build_default_firmware
For users For users
========= =========
Customizing your firmware
-------------------------
.. toctree:: .. toctree::
:caption: Customizing your firmware
:maxdepth: 1 :maxdepth: 1
:glob: :glob:
customization/* layers.md
keycodes.md
Plugins customization/**
------- plugin_list.rst
.. toctree::
:maxdepth: 1
:glob:
plugins/*
Supported input devices
-----------------------
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Supported devices
:glob: :glob:
hardware-devices/* hardware-devices/**
For developers For developers
============== ==============
Understanding the codebase
--------------------------
.. toctree:: .. toctree::
:caption: Understanding the codebase
:maxdepth: 1 :maxdepth: 1
:glob:
codebase/design-philosophy.md
codebase/glossary.md
codebase/code-style.md
codebase/release-testing.md
API Design docs codebase/**
---------------
.. toctree:: .. toctree::
:caption: API Design
:maxdepth: 1 :maxdepth: 1
:glob: :glob:
api-reference/* api-reference/**
Device drivers
--------------
.. toctree:: .. toctree::
:maxdepth: 1 :caption: Device Drivers
:glob: :glob:
drivers/** drivers/**
Development tips
----------------
.. toctree:: .. toctree::
:maxdepth: 1 :caption: Development tips
:glob: :glob:
development/** development/**
What's new in v2.0
------------------
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Changes
NEWS.md NEWS.md
Upgrading from old versions
---------------------------
.. toctree::
:maxdepth: 1
UPGRADING.md UPGRADING.md
For Everybody
=============
.. toctree:: .. toctree::
:maxdepth: 0 :maxdepth: 1
:caption: Code of Conduct
code_of_conduct.md code_of_conduct.md
WIP
===
.. toctree:: .. toctree::
:caption: Docs that don't work yet
:maxdepth: 2 :maxdepth: 2
examples examples
about about
api/library_root api/library_root

10
docs/plugin_list.rst
Unescape View File

@ -0,0 +1,10 @@
Bundled plugins
===============
.. toctree::
:caption: Bundled plugins
:maxdepth: 1
:glob:
plugins/*

20
docs/setup_toolchain.md
Unescape View File

@ -20,7 +20,7 @@ The right way to install Arduino is a little bit different depending on what ope
* [Install Arduino on FreeBSD](#Arduino-FreeBSD) * [Install Arduino on FreeBSD](#Arduino-FreeBSD)
## <a name="Arduino-macOS"/>Install Arduino on macOS ## <a name="Arduino-macOS"></a>Install Arduino on macOS
@ -34,10 +34,10 @@ As of this writing, the latest version is v1.8.13, which you can download from h
4. Double-click on Arduino.app to start it. 4. Double-click on Arduino.app to start it.
Next step: [Add keyboard support to Arduino](#Add-keyboard-support-to-Arduino) Next step: [Add keyboard support to Arduino](#add-keyboard-support-to-arduino)
# <a name="Arduino-Linux"/>Install Arduino on Linux ## <a name="Arduino-Linux"></a>Install Arduino on Linux
1. Install version 1.8.13 or newer of the Arduino IDE from http://arduino.cc/download. Unfortunately, the version packaged in Ubuntu is too ancient to support Arduino's new way of doing 3rd-party hardware. 1. Install version 1.8.13 or newer of the Arduino IDE from http://arduino.cc/download. Unfortunately, the version packaged in Ubuntu is too ancient to support Arduino's new way of doing 3rd-party hardware.
@ -77,7 +77,7 @@ Next step: [Add keyboard support to Arduino](#Add-keyboard-support-to-Arduino)
On Arch linux, Manjaro linux, and probably other Arch derivatives, the group for the device access is `uucp`. To add yourself to this group if necessary, use On Arch linux, Manjaro linux, and probably other Arch derivatives, the group for the device access is `uucp`. To add yourself to this group if necessary, use
```shq ```sh
$ sudo usermod -a -G uucp $USER $ sudo usermod -a -G uucp $USER
$ newgrp uucp # or su - $USER, or log out and in again $ newgrp uucp # or su - $USER, or log out and in again
``` ```
@ -88,9 +88,9 @@ Next step: [Add keyboard support to Arduino](#Add-keyboard-support-to-Arduino)
export ARDUINO_PATH=/usr/local/arduino export ARDUINO_PATH=/usr/local/arduino
``` ```
Next step: [Add keyboard support to Arduino](#Add-keyboard-support-to-Arduino) Next step: [Add keyboard support to Arduino](#add-keyboard-support-to-arduino)
# <a name="Arduino-Windows"/>Install Arduino on Windows 10 ## <a name="Arduino-Windows"></a>Install Arduino on Windows 10
_**Note:** This tutorial has been written using Windows 10._ _**Note:** This tutorial has been written using Windows 10._
@ -106,9 +106,9 @@ _**Note:** Some users have had difficulties with the Windows store version of th
2. Open the installation package and follow the prompts to install the Arduino IDE. 2. Open the installation package and follow the prompts to install the Arduino IDE.
Next step: [Add keyboard support to Arduino](#Add-keyboard-support-to-Arduino) Next step: [Add keyboard support to Arduino](#add-keyboard-support-to-arduino)
## <a name="Arduino-FreeBSD"/>Install Arduino on FreeBSD ## <a name="Arduino-FreeBSD"></a>Install Arduino on FreeBSD
1. Install the following packages required by the build system: `bash`, `gmake`, `perl5`, `avrdude`, and `arduino18`. 1. Install the following packages required by the build system: `bash`, `gmake`, `perl5`, `avrdude`, and `arduino18`.
@ -151,10 +151,10 @@ Next step: [Add keyboard support to Arduino](#Add-keyboard-support-to-Arduino)
$ sudo service devfs restart $ sudo service devfs restart
``` ```
Next step: [Add keyboard support to Arduino](#Add-keyboard-support-to-Arduino) Next step: [Add keyboard support to Arduino](#add-keyboard-support-to-arduino)
# <a name="Add-keyboard-support-to-Arduino"/>Add keyboard support to Arduino # Add keyboard support to Arduino
1. Open the Arduino IDE. It will open an empty "sketch" window. 1. Open the Arduino IDE. It will open an empty "sketch" window.

Write Preview
Loading…
Cancel
Save