zephyr/doc/application/apps_dev_process.rst
Rodrigo Caballero 4f976c20d7 doc: Refactor the Quick Start Guide.
Restructured the guide to follow a basic three step process: Set up, develop,
build. All information that is independent of the OS selection was taken out of
of the OS related documents and placed in the general set up sections.

A new section, Developing Zephyr Applications, was added with links to all the
development relevant section of the documentation.

The content in local_development.rst was split between the setting_up.rst,
installation_linux.rst and installation_mac.rst files as appropriate.

This new structure provides a much better flow for developers beginning their
Zephyr develpment.

Applied all of Inaky's suggestions in the refactored content.

Minor markup fixes and language edits were also perfomed during the refactoring.

Fixed a cross-reference that was broken during the refactor.

Applied all the feedback from the first trial run.

Applied the feedback provided by David Kinder from TCS.

Change-Id: I3368a3a41ec9ad02cc4e7b37fe71c65abd8a7df9
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-05 20:25:30 -05:00

57 lines
1.4 KiB
ReStructuredText

.. _apps_dev_process:
Application Development Workflow
################################
The application development workflow identifies procedures needed to create, build, and
run a Zephyr microkernel or nanokernel application.
Before you build
----------------
* Check that your Linux host meets the minimum requirements specified in the
:ref:`getting_started`.
* Check that environment variables have been configured correctly as outlined
in :ref:`apps_common_procedures`.
Workflow
--------
1. Create a directory structure for your Zephyr application.
a) :ref:`create_directory_structure`
2. Add a Makefile
b) :ref:`create_src_makefile`
3. Define the application's default kernel configuration using
:ref:`define_default_kernel_conf`.
4. Define kernel configuration override options for the application
using :ref:`override_kernel_conf`.
5. For a microkernel application, define objects as you develop code
using :ref:`create_mdef`.
6. For all applications, define nanokernel objects as you need them in
code.
7. Develop source code and add source code files to the src directory.
* :ref:`naming_conventions`
* :ref:`src_makefiles_reqs`
* :ref:`src_files_directories`
8. Build an application image.
* :ref:`apps_build`
9. To test the application image's functionality on simulated hardware
with QEMU, see :ref:`apps_run`.
10. To load an application image on a target hardware, see using
:ref:`board` documentation.