Skip to content

Commit 9d1b6cf

Browse files
committed
Mostly finish docs and driver pages
Fixes ev3dev#242
1 parent 52800ca commit 9d1b6cf

2 files changed

Lines changed: 26 additions & 25 deletions

File tree

docs/driver-access.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,21 @@ subtitle: Controlling ev3dev devices through the low-level drivers
66
Ev3dev exposes motors, sensors and other EV3-related devices through a set of
77
drivers that are built into the platform. If you want to access those drivers
88
directly instead of using [a pre-built library](/docs/libraries), you'll need
9-
to read from and write to the sysfs properties that ev3dev exposes.
9+
to read from and write to the sysfs properties that ev3dev exposes. Here are
10+
some resources to get you started.
1011

11-
**TODO**
12+
- **[Input and output ports](/docs/ports)**: The input and output ports on the
13+
EV3 and other ev3dev-supported hardware.
14+
15+
- **[Supported Sensors and Other Input Devices](/docs/sensors)**: The drivers and
16+
interfaces that operate sensors and other input devices.
17+
18+
- **[Supported Motors and Other Output Devices](/docs/motors)**: The drivers and
19+
interfaces that operate motors and other output devices. The most common
20+
motor interface on ev3dev is the [`tacho-motor` class](/docs/drivers/tacho-motor-class/),
21+
so it is important to read through the documentation for it when writing motor
22+
code. You can also read through our [tacho motor tutorial](/docs/tutorials/tacho-motors)
23+
to learn how to use the motor interface.
24+
25+
- **[ev3dev kernel drivers](/docs/drivers)**: An index of all the special
26+
hardware drivers that ev3dev ships with.

docs/index.html

Lines changed: 9 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
<h2>System setup</h2>
2929
<p>
3030
If you're looking to set up a new installation of ev3dev, check out
31-
our <a href="getting-started">getting started</a> guide.
31+
our <a href="/docs/getting-started">Getting Started</a> guide.
3232
</p>
3333

3434
<h2>Tutorials</h2>
@@ -40,30 +40,16 @@ <h2>Tutorials</h2>
4040

4141
<h2>Writing some software</h2>
4242
<p>
43-
To take advantage of ev3dev's main functionality, you'll probably need to use a pre-built library from
44-
<a href="libraries">our central list of known libraries</a>.
45-
46-
<b>TODO</b>
43+
To take advantage of ev3dev's main functionality, you'll probably want to
44+
use a pre-built library from <a href="/docs/libraries">our central list of
45+
known libraries</a>. Choose a language to get started!
4746
</p>
4847

49-
<!-- that have been developed to simplify developing
50-
with ev3dev. If you need to directly program against the ev3dev driver APIs, you can read our
51-
info pages on the following topics: -->
52-
53-
<ul>
54-
<li>
55-
<a href="ports">Input and output ports</a>
56-
</li>
57-
<li>
58-
<a href="sensors">Supported Sensors and Other Input Devices</a>
59-
</li>
60-
<li>
61-
<a href="motors">Supported Motors and Other Output Devices</a>
62-
</li>
63-
<li>
64-
<a href="drivers">ev3dev kernel drivers</a>
65-
</li>
66-
</ul>
48+
<h3>Low-level driver access</h3>
49+
<p>
50+
If you need to directly program against the ev3dev driver APIs, you can
51+
check out our <a href="/docs/driver-access">driver access landing page</a>.
52+
</p>
6753

6854
<h2>Developing the ev3dev kernel</h2>
6955
<p>

0 commit comments

Comments
 (0)