docs: modified index pages for documentation to link to samples repo

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu 2015-06-04 15:16:25 -07:00
parent ea544e8391
commit 6efe6916ba
3 changed files with 162 additions and 135 deletions

View File

@ -23,6 +23,9 @@ may also create more complex structures in order to interface with them.
Browse through the list of all [examples](https://github.com/intel-iot-devkit/upm/tree/master/examples). Browse through the list of all [examples](https://github.com/intel-iot-devkit/upm/tree/master/examples).
Multi-sensor samples for the starter and specialized kits can be found in the
[iot-devkit-samples](https://github.com/intel-iot-devkit/iot-devkit-samples) repository.
### Supported Sensors ### Supported Sensors
Supported [sensor list](http://iotdk.intel.com/docs/master/upm/modules.html) from API documentation. Supported [sensor list](http://iotdk.intel.com/docs/master/upm/modules.html) from API documentation.

View File

@ -15,6 +15,14 @@
For building UPM, please follow this `link <https://github.com/intel-iot-devkit/upm/blob/master/docs/building.md>`_. For building UPM, please follow this `link <https://github.com/intel-iot-devkit/upm/blob/master/docs/building.md>`_.
``Examples``
############
Multi-sensor samples for the starter and specialized kits can be found in the `iot-devkit-samples <https://github.com/intel-iot-devkit/iot-devkit-samples>`_
repository.
Individual sensor usage examples for python are available `here <https://github.com/intel-iot-devkit/upm/tree/master/examples/python>`_.
``Making your own UPM Module`` ``Making your own UPM Module``
############################## ##############################

View File

@ -13,13 +13,29 @@
allows to interface with it. Typically a sensor is represented as a allows to interface with it. Typically a sensor is represented as a
class and instantiated.</p> class and instantiated.</p>
<p>The constructor is expected to initialise the sensor and <p>The constructor is expected to initialise the sensor and parameters
parameters may be used to provide identification/pin location on the may be used to provide identification/pin location on the board.</p>
board.</p>
<p>Typically an update() function will be called in order to get new <p>Typically an update() function will be called in order to get new
data from the sensor in order to reduce load when doing multiple data from the sensor in order to reduce load when doing multiple reads
reads to sensor data.</p> to sensor data.</p>
<div class="section" id="examples">
<h3><code class="docutils literal"><span class="pre">Examples</span></code><a class="headerlink"
href="#examples"
title="Permalink to this headline">*</a></h3>
<p>Multi-sensor samples for the starter and specialized kits can be
found in the
<a class="reference external"
href="https://github.com/intel-iot-devkit/iot-devkit-samples">iot-devkit-samples</a>
repository.</p>
<p>Individual sensor usage examples for node.js are available
<a class="reference external"
href="https://github.com/intel-iot-devkit/upm/tree/master/examples/javascript">here</a>.</p>
</div>
<div class="section" id="building-upm"> <div class="section" id="building-upm">
<h3><tt class="docutils literal"><span class="pre">Building</span> <h3><tt class="docutils literal"><span class="pre">Building</span>
<span class="pre">UPM</span></tt><a class="headerlink" <span class="pre">UPM</span></tt><a class="headerlink"
@ -79,10 +95,10 @@
<p class="first admonition-title">Note</p> <p class="first admonition-title">Note</p>
<ul class="last simple"> <ul class="last simple">
<li>Make sure you add yourself as an author on every new <li>Make sure you add yourself as an author on every new code
code file submitted.</li> file submitted.</li>
<li>If you are providing a fix with significant changes, <li>If you are providing a fix with significant changes, feel
feel free to add yourself as a contributor.</li> free to add yourself as a contributor.</li>
<li>Signing-off your commits is mandatory.</li> <li>Signing-off your commits is mandatory.</li>
</ul> </ul>
</div> </div>