michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: add template for sample documentation

Browse source 
Change-Id: I2396f4f95d5ad9abd7ca9a718e0d16bba86a437e
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2017-01-06 13:26:28 -05:00
commit e54e66a3d0
2 changed files with 31 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

29
doc/templates/sample.tmpl vendored Normal file
View file

@ -0,0 +1,29 @@
[A Descriptive Title]
#####################
Overview
========
[A short description about the sample and what it does]
Requirements
============
[List of required software and hardware components. Provide pointers to
hardware components such as sensors and shields]
Wiring
======
[For simple projects, a description of how to wire the board for the demo. For
complex projects, provide a graphic with more details, preferably using
Fritzing or some other visualisation tools]
Building and Running
====================
[ How to build the sample and how to run it. Pointers to where to find the
sample in the source tree and how to configure it and run it for a specific
target platform]
References
==========
[ Links to external references such as datasheets or additional documentation]

2
samples/samples.rst
View file

@ -17,3 +17,5 @@ Samples and Demos
To add a new sample documentation, please use the template available under
:file:`doc/templates/sample.tmpl`