Commit Graph

21 Commits

Author SHA1 Message Date
Marc Herbert
3539f3ddfa doc: Use Copy/paste: mention accessibility
Trying to stem the tide of screenshots; every little helps?

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
2023-02-09 11:12:32 +01:00
Stephanos Ioannidis
d90eea51fb doc: Update to Zephyr SDK 0.15.2
Update the Getting Started Guide and the Zephyr SDK documentation to
point to the Zephyr SDK 0.15.2 release.

Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
2022-11-24 07:35:13 -05:00
Uma Praseeda
90577ee5d8 doc: Add reference labels in getting started doc
Add reference labels in getting_started/index.rst

Signed-off-by: Uma Praseeda <uma.praseeda@nordicsemi.no>
2022-11-09 14:42:45 +01:00
Stephanos Ioannidis
88af5964ed doc: Update to Zephyr SDK 0.15.1
Update the Getting Started Guide and the Zephyr SDK documentation to
point to the Zephyr SDK 0.15.1 release.

Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
2022-10-12 19:23:32 -04:00
Daniel DeGrasse
f1bafda5e5 docs: getting_started: add note about west boards command
Add note about west boards command to getting started documentation,
to make it easier for users to determine the name of their board when used
with west. Also change "-p auto" to "-p always" in the build step, since
this is more deterministic

Signed-off-by: Daniel DeGrasse <daniel.degrasse@nxp.com>
2022-08-30 16:44:23 +02:00
Daniel DeGrasse
e1bcc0a0cc docs: getting_started: change default python setup to use virtual env
Change default python setup suggested in getting started guide to use
virtual environments. This aligns with the documentation itself, which
suggests that users use virtual environments with Zephyr. The Windows
python setup is also updated with the correct command to create a
virtual environment, as "python3" is not a defined executable in a
windows commandline after installing python with chocolatey

Signed-off-by: Daniel DeGrasse <daniel.degrasse@nxp.com>
2022-08-30 16:44:23 +02:00
Stephanos Ioannidis
d9929556b3 doc: Update to Zephyr SDK 0.15.0
Update the Getting Started Guide and the Zephyr SDK documentation to
point to the Zephyr SDK 0.15.0 release.

Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
2022-08-29 16:57:18 +02:00
Diego Herranz
66d47cae04 doc/develop/getting_started: update for Ubuntu 22.04
In Ubuntu 22.04 there is no need to add any extra repositories
to meet the minimum required versions for tools like cmake and dtc.
In fact, the Kitware repos don't even work in Ubuntu 22.04.

So, instructions updated to explain that step is only required for
Ubuntu versions older than 22.04.

Signed-off-by: Diego Herranz <diegoherranz@diegoherranz.com>
2022-08-25 23:39:23 -07:00
Carles Cufi
7743b6da85 doc: Require Python 3.8
Given that 3.6 is now several years old and the current and previous
 Ubuntu LTS ship with 3.8 or later, upgrade the minimum required Python
version from 3.6 to 3.8.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2022-08-24 18:35:57 +02:00
Grzegorz Ferenc
5b108be3d1 doc: gsg: Edit instructions to set SDK env vars
Edited the changes added in commit 0a758c3.
The changes aim at including the variable info
in a note before the OS installation procedure for major visibility.
Also added subsections on zephyr_sdk.rst page.

Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>
2022-07-06 08:25:44 -07:00
Carles Cufi
f9739ab41d python: Fix the requirement for libmagic to be installed
The Python python-magic module that we install for compliance checks
requires libmagic to be installed on the system to work. This requires
extra OS packages on Ubuntu and macOS, and an extra wheel on Windows.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2022-06-30 13:34:26 +02:00
Gerard Marull-Paretas
3009b8d9e6 doc: getting_started: add missing python3-venv installation
The venv package is not installed by default on Ubuntu, however, it is
required to follow the virtual environment installation path.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-06-09 14:35:18 +02:00
Carles Cufi
0a758c36c8 doc: gsg: Include instructions to set SDK env vars
The basic environment variables need to be set to be able to build
blinky (at least ZEPHYR_TOOLCHAIN_VARIANT) but were not inlcuded in the
GSG.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
Co-authored-by: Marti Bolivar <marti.bolivar@nordicsemi.no>
2022-06-07 10:45:31 -07:00
Stephanos Ioannidis
2598f0ed3c doc: toolchains: Add Zephyr SDK documentation
This commit adds a dedicated page for the Zephyr SDK under the
'Toolchains' sub-category under 'Developing with Zephyr'.

The content of this page is based on the Zephyr SDK installation
instruction from the 'Getting Started Guide'.

Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
2022-06-01 15:26:48 +02:00
Stephanos Ioannidis
df14444a38 doc: toolchains: Add pages for individual toolchains
This commit adds individual documentation page for each toolchain type
based on the content from the `3rd_party_x_compilers.rst` file in order
to improve visibility.

Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
2022-06-01 15:26:48 +02:00
Stephanos Ioannidis
26b019f2f0 doc: develop: Add 'Toolchains' sub-category
This commit adds the 'Toolchains' sub-category under the 'Developing
with Zephyr' category with toolchain-related documentations that were
previously located under the 'Getting Started Guide' sub-category.

It also reworks the toolchain-related documentation in the "Beyond
Getting Started Guide" document such that it is more up to date and any
confusing and/or misleading details are removed.

Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
2022-06-01 15:26:48 +02:00
Stephanos Ioannidis
4ae0e186a1 doc: getting_started: Improve consistency for SDK instructions
This commit renames the "Install a Toolchain" section in the Getting
Started Guide to "Install Zephyr SDK" so that it reflects the actual
content of the section.

Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
2022-06-01 15:26:48 +02:00
Stephanos Ioannidis
2d8c45c1e0 doc: Update to Zephyr SDK 0.14.2
Update the Getting Started Guide to point to the Zephyr SDK 0.14.2
release.

Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
2022-05-19 11:26:06 -07:00
Timon Skerutsch
bce3c404fb doc: Add a notice that you are free to choose compiler path
Works just fine if I point it to the default install path from
the Arm GCC installer which contains several spaces.
"C:\Program Files (x86)\GNU Arm Embedded Toolchain\x.x.x\"

The previous notice about not using spaces made sense to have this
very specific path but this might confuse people who install
ARM GCC with the provided installer which puts it into a path
under C:\Program FIles, to avoid people moving their installation
and possibly breaking a different setup I thinks its good
to make that clear that this is not a hard coded assumption
made across Zephyr and is just a matter of an ENV variable.

Signed-off-by: Timon Skerutsch <timon@diodes-delight.com>
Co-Authored-By: Stephanos Ioannidis <root@stephanos.io>
2022-05-13 10:48:14 -07:00
Stephanos Ioannidis
82b6a2a020 doc: Update to Zephyr SDK 0.14.1
Update the Getting Started Guide to point to the Zephyr SDK 0.14.1
release.

Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
2022-04-19 09:15:06 -04:00
Anas Nashif
5ca2eae5d5 doc: add new section 'Developing with Zephyr'
Move all introductionary docs into one new section.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-07 16:35:19 +02:00