Skip to content

Commit

Permalink
doc: New developer getting started guide
Browse files Browse the repository at this point in the history
As presented to the TSC, Zephyr's out-of-box experience for new
developers is, well, complicated.  A number of suggestions were
presented including simplifying the getting started material to present
a straight-forward path through the setup and installation steps through
to getting a sample application built, flashed, and running.

This PR is a work-in-progress towards addressing this OOB experience
with a minimal-distractions version of the GSG. Alternatives, warnings,
and material that could lead the developer astray were moved to
alternative/advanced instruction documents (based on the previous
separate Linux/macOS/Windows setup guides) and a new "Beyond the GSG"
document.

We do take advantage of a sphinx-tabs extension for synchronized tabs to
present OS-specific instructions: clicking on one tab will display all
same-named tabs throughout the doc.

We hope (and will continue evaluating) that this new GSG gets developers
set up quickly and then we can send them along to other documents to
continue learning about Zephyr and trying other sample apps.

Thanks for all your previous feedback that I've worked
into this new version.

Signed-off-by: David B. Kinder <[email protected]>
  • Loading branch information
dbkinder authored and MaureenHelm committed Nov 13, 2019
1 parent b4ddc10 commit 3312147
Show file tree
Hide file tree
Showing 11 changed files with 798 additions and 277 deletions.
2 changes: 2 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ Community Support
Community support is provided via mailing lists and Slack; see the Resources
below for details.

.. _project-resources:

Resources
*********

Expand Down
3 changes: 2 additions & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,8 @@
'zephyr.application',
'zephyr.html_redirects',
'only.eager_only',
'zephyr.link-roles'
'zephyr.link-roles',
'sphinx_tabs.tabs'
]

# Only use SVG converter when it is really needed, e.g. LaTeX.
Expand Down
Binary file added doc/getting_started/img/ReelBoard-Blinky.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 3312147

Please sign in to comment.