Skip to content

Commit 8b81294

Browse files
dbkinderAnas Nashif
authored andcommitted
doc: environment setup needs zephyr clone first
There are files in the cloned copy of the Zephyr tree needed to setup the development environment, so there's a bit of chicken and egg problem. Signed-off-by: David B. Kinder <[email protected]>
1 parent cbf3e7b commit 8b81294

File tree

4 files changed

+23
-15
lines changed

4 files changed

+23
-15
lines changed

doc/getting_started/getting_started.rst

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,26 @@ Getting Started Guide
66
Use this guide to get started with your :ref:`Zephyr <introducing_zephyr>`
77
development.
88

9+
Checking Out the Source Code Anonymously
10+
****************************************
11+
12+
The Zephyr source code is hosted in a GitHub repo that supports
13+
anonymous cloning via git. There are scripts and such in this repo that
14+
you'll need to set up your development environment, and we'll be using
15+
Git to get this repo. (If you don't have Git installed, see the
16+
beginning of the OS-specific instructions below for help.)
17+
18+
We'll begin by
19+
using Git to clone the repository anonymously. Enter:
20+
21+
.. code-block:: console
22+
23+
$ cd ~
24+
$ git clone https://github.com/zephyrproject-rtos/zephyr.git
25+
26+
You have successfully checked out a copy of the source code to your local
27+
machine in the ~/zephyr folder.
28+
929
Set Up the Development Environment
1030
**********************************
1131

@@ -25,21 +45,6 @@ Use the following procedures to create a new development environment.
2545
installation_win.rst
2646

2747

28-
Checking Out the Source Code Anonymously
29-
========================================
30-
31-
The code is hosted in a GitHub repo that supports
32-
anonymous cloning via git.
33-
34-
To clone the repository anonymously, enter:
35-
36-
.. code-block:: console
37-
38-
$ git clone https://github.com/zephyrproject-rtos/zephyr.git
39-
40-
You have successfully checked out a copy of the source code to your local
41-
machine.
42-
4348
.. _getting_started_run_sample:
4449

4550
Building and Running an Application

doc/getting_started/installation_linux.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ Install the required packages in a Fedora host system with:
6767
6868
Install additional packages required for development with Zephyr::
6969

70+
$ cd ~/zephyr # or to your directory where zephyr is cloned
7071
$ pip3 install --user -r scripts/requirements.txt
7172

7273
CMake version 3.8.2 or higher is required. Check what version you have using

doc/getting_started/installation_mac.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ Install tools to build Zephyr binaries:
6161
$ curl -O 'https://bootstrap.pypa.io/get-pip.py'
6262
$ ./get-pip.py
6363
$ rm get-pip.py
64+
$ cd ~/zephyr # or to the folder where you cloned the zephyr repo
6465
$ pip3 install --user -r scripts/requirements.txt
6566
6667
Source :file:`zephyr-env.sh` wherever you have cloned the Zephyr Git repository:

doc/getting_started/installation_win.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ environment for Windows. Follow the steps below to set it up:
7373
$ curl -O 'https://bootstrap.pypa.io/get-pip.py'
7474
$ ./get-pip.py
7575
$ rm get-pip.py
76+
$ cd ~/zephyr # or to the folder where you cloned the zephyr repo
7677
$ pip install --user -r scripts/requirements.txt
7778

7879
#. The build system should now be ready to work with any toolchain installed in

0 commit comments

Comments
 (0)