Files
xod/docs/README.md
2017-12-14 19:53:40 +03:00

85 lines
2.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
title: XOD Documentation
---
XOD Documentation
=================
Tutorials
---------
* [Installing and running XOD](./tutorial/install/)
* [Required hardware](./tutorial/required-hardware/)
1. [Hello](./tutorial/01-hello)
2. [Upload to Arduino](./tutorial/02-deploy)
3. [Pins, data, and the Inspector](./tutorial/03-inspector)
4. [Fractional numbers and PWM](./tutorial/04-pwm)
5. [Wiring configuration](./tutorial/05-wiring)
6. [Adding nodes](./tutorial/06-adding-nodes)
7. [Node labels](./tutorial/07-labels)
8. [Constant nodes](./tutorial/08-constants)
9. [Input from a potentiometer](./tutorial/09-pot)
10. [Doing math](./tutorial/10-math)
11. [Controlling servos](./tutorial/11-servo)
12. [Accessing help](./tutorial/12-help)
13. [Mapping values](./tutorial/13-map)
14. [Adjusting map range](./tutorial/14-map-adjust)
15. [Buttons](./tutorial/15-buttons)
16. [Logic nodes](./tutorial/16-logic)
17. [Reading lightness](./tutorial/17-ldr)
18. [Comparing numbers](./tutorial/18-comparisons)
19. [If-else branching](./tutorial/19-if-else)
20. [Smoother changes](./tutorial/20-fade)
* [Complex projects?](./tutorial/complex-projects/)
### Contributed tutorials
* [Découvrir et utiliser XOD](http://formations.open-elearning.fr/modules/electronique/xod/decouverte/) (French, by [@pepe](https://forum.xod.io/u/pepe/summary))
### Obsolete tutorials
The articles which are going to be superseeded by the crash course above.
1. [Nodes and Links](./tutorial/nodes-and-links/)
1. [Data Types and Conversions](./tutorial/data-types-and-conversions/)
1. [Patch Nodes](./tutorial/patch-nodes/)
Users guide
------------
### Making your own nodes
* [Creating nodes for XOD in XOD](./guide/nodes-for-xod-in-xod/)
* [Creating analog sensor driver nodes](./guide/analog-sensor-node/)
* [Documenting nodes](./guide/documenting-nodes/)
* [Creating nodes for XOD in C++](./guide/nodes-for-xod-in-cpp/)
* [Dealing with state in C++](./guide/cpp-state/)
* [Dealing with time in C++](./guide/cpp-time/)
### Doing things sequentially
* [Simple traffic light example](./guide/simple-traffic-light/)
### Concepts
* [Program structure](./guide/program-structure/)
* [Data types](./guide/data-types/)
* [Linking rules](./guide/linking-rules/)
* [Execution model](./guide/execution-model/)
Reference
---------
* [List of supported hardware](./reference/supported-hardware/)
* [Mouse and keyboard shortcuts](./reference/shortcuts/)
* [C++ node API reference](./reference/node-cpp-api/)
### Standard library nodes
* [`xod/core`](/libs/xod/core/)
* [`xod/common-hardware`](/libs/xod/common-hardware/)
* [`xod/units`](/libs/xod/units/)
* [`xod/bits`](/libs/xod/bits/)