doc: Create "Introducing Zephyr" document
Relocates the introductory material for Zephyr into a new document, so that it can be more easily located by users. (Previously this info couldn't be accessed from the list of documents on the left hand side of a web page; instead, you had to click on the "Documentation" tab at the top of the page, which is non-intuitive.) Change-Id: I1e1f78162a314b958789fcef57fc864336007f3c Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
This commit is contained in:
Allan Stephens
Inaky Perez-Gonzalez
parent
2b13ba21cf
commit
83bbc7c0e5
3 changed files with 68 additions and 68 deletions
|
|
@ -3,7 +3,7 @@
|
|||
Getting Started Guide
|
||||
#####################
|
||||
|
||||
Use this guide to get started with your :ref:`Zephyr <about_zephyr>`
|
||||
Use this guide to get started with your :ref:`Zephyr <introducing_zephyr>`
|
||||
development.
|
||||
|
||||
Set Up the Development Environment
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ Zephyr Project Documentation
|
|||
|
||||
Documentation for released versions of Zephyr can be found at
|
||||
``https://www.zephyrproject.org/doc/<version>``. The following documentation
|
||||
versions are vailable:
|
||||
versions are available:
|
||||
|
||||
`Zephyr 1.1.0`_ | `Zephyr 1.2.0`_ | `Zephyr 1.3.0`_ | `Zephyr 1.4.0`_
|
||||
|
||||
|
|
@ -28,6 +28,7 @@ Sections
|
|||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
introduction/introducing_zephyr.rst
|
||||
getting_started/getting_started.rst
|
||||
board/board.rst
|
||||
kernel/kernel.rst
|
||||
|
|
@ -41,72 +42,6 @@ Sections
|
|||
|
||||
You can find further information on the `Zephyr Project Wiki`_.
|
||||
|
||||
.. _about_zephyr:
|
||||
|
||||
Introduction to the Zephyr Project
|
||||
##################################
|
||||
|
||||
The Zephyr Kernel is a small-footprint kernel designed for use on
|
||||
resource-constrained systems: from simple embedded environmental
|
||||
sensors and LED wearables to sophisticated smart watches and IoT
|
||||
wireless gateways.
|
||||
|
||||
It is designed to be supported by multiple architectures, including
|
||||
ARM Cortex-M, Intel x86, and ARC. The full list of supported platforms
|
||||
can be found :ref:`here <board>`.
|
||||
|
||||
Licensing
|
||||
*********
|
||||
|
||||
The Zephyr project associated with the kernel makes it available
|
||||
to users and developers under the Apache License, version 2.0.
|
||||
|
||||
Distinguishing Features
|
||||
***********************
|
||||
|
||||
The Zephyr Kernel offers a number of features that distinguish it from other
|
||||
small-footprint OSes:
|
||||
|
||||
#. **Single address-space OS**. Combines application-specific code
|
||||
with a custom kernel to create a monolithic image that gets loaded
|
||||
and executed on a system's hardware. Both the application code and
|
||||
kernel code execute in a single shared address space.
|
||||
|
||||
#. **Highly configurable**. Allows an application to incorporate *only*
|
||||
the capabilities it needs as it needs them, and to specify their
|
||||
quantity and size.
|
||||
|
||||
#. **Resources defined at compile-time**. Requires all system resources
|
||||
be defined at compilation time, which reduces code size and
|
||||
increases performance.
|
||||
|
||||
#. **Minimal error checking**. Provides minimal run-time error checking
|
||||
to reduce code size and increase performance. An optional error-checking
|
||||
infrastructure is provided to assist in debugging during application
|
||||
development.
|
||||
|
||||
#. **Extensive suite of services** Offers a number of familiar services
|
||||
for development:
|
||||
|
||||
* *Multi-threading Services* for both priority-based, non-preemptive
|
||||
fibers and priority-based, preemptive tasks with optional round robin
|
||||
time-slicing.
|
||||
|
||||
* *Interrupt Services* for both compile-time and run-time registration
|
||||
of interrupt handlers.
|
||||
|
||||
* *Inter-thread Synchronization Services* for binary semaphores,
|
||||
counting semaphores, and mutex semaphores.
|
||||
|
||||
* *Inter-thread Data Passing Services* for basic message queues, enhanced
|
||||
message queues, and byte streams.
|
||||
|
||||
* *Memory Allocation Services* for dynamic allocation and freeing of
|
||||
fixed-size or variable-size memory blocks.
|
||||
|
||||
* *Power Management Services* such as tickless idle and an advanced idling
|
||||
infrastructure.
|
||||
|
||||
Indices and Tables
|
||||
******************
|
||||
|
||||
|
|
|
|||
65
doc/introduction/introducing_zephyr.rst
Normal file
65
doc/introduction/introducing_zephyr.rst
Normal file
|
|
@ -0,0 +1,65 @@
|
|||
.. _introducing_zephyr:
|
||||
|
||||
Introducing Zephyr
|
||||
##################
|
||||
|
||||
The Zephyr kernel is a small-footprint kernel designed for use on
|
||||
resource-constrained systems: from simple embedded environmental
|
||||
sensors and LED wearables to sophisticated smart watches and IoT
|
||||
wireless gateways.
|
||||
|
||||
It is designed to be supported by multiple architectures, including
|
||||
ARM Cortex-M, Intel x86, and ARC. The full list of supported platforms
|
||||
can be found :ref:`here <board>`.
|
||||
|
||||
Licensing
|
||||
*********
|
||||
|
||||
The Zephyr project associated with the kernel makes it available
|
||||
to users and developers under the Apache License, version 2.0.
|
||||
|
||||
Distinguishing Features
|
||||
***********************
|
||||
|
||||
The Zephyr kernel offers a number of features that distinguish it from other
|
||||
small-footprint OSes:
|
||||
|
||||
#. **Single address-space OS**. Combines application-specific code
|
||||
with a custom kernel to create a monolithic image that gets loaded
|
||||
and executed on a system's hardware. Both the application code and
|
||||
kernel code execute in a single shared address space.
|
||||
|
||||
#. **Highly configurable**. Allows an application to incorporate *only*
|
||||
the capabilities it needs as it needs them, and to specify their
|
||||
quantity and size.
|
||||
|
||||
#. **Resources defined at compile-time**. Requires all system resources
|
||||
be defined at compilation time, which reduces code size and
|
||||
increases performance.
|
||||
|
||||
#. **Minimal error checking**. Provides minimal run-time error checking
|
||||
to reduce code size and increase performance. An optional error-checking
|
||||
infrastructure is provided to assist in debugging during application
|
||||
development.
|
||||
|
||||
#. **Extensive suite of services** Offers a number of familiar services
|
||||
for development:
|
||||
|
||||
* *Multi-threading Services* for both priority-based, non-preemptive
|
||||
fibers and priority-based, preemptive tasks with optional round robin
|
||||
time-slicing.
|
||||
|
||||
* *Interrupt Services* for both compile-time and run-time registration
|
||||
of interrupt handlers.
|
||||
|
||||
* *Inter-thread Synchronization Services* for binary semaphores,
|
||||
counting semaphores, and mutex semaphores.
|
||||
|
||||
* *Inter-thread Data Passing Services* for basic message queues, enhanced
|
||||
message queues, and byte streams.
|
||||
|
||||
* *Memory Allocation Services* for dynamic allocation and freeing of
|
||||
fixed-size or variable-size memory blocks.
|
||||
|
||||
* *Power Management Services* such as tickless idle and an advanced idling
|
||||
infrastructure.
|
||||
Loading…
Add table
Add a link
Reference in a new issue