]> granicus.if.org Git - esp-idf/commitdiff
Added a section how to update existing local esp-idf repository and load specific...
authorkrzychb <krzychb@gazeta.pl>
Fri, 15 Sep 2017 17:54:36 +0000 (19:54 +0200)
committerkrzychb <krzychb@gazeta.pl>
Fri, 15 Sep 2017 17:54:36 +0000 (19:54 +0200)
docs/get-started/index.rst

index 31cda9cf3df9010f9d7252f50eb39cc247ae32bf..a19b805e3d3c2aa5a52cfb5b95af9f3e84f8cb19 100644 (file)
@@ -284,6 +284,34 @@ Several lines below, after start up and diagnostic log, you should see "Hello wo
 \r
 To exit monitor use shortcut ``Ctrl+]``. To execute ``make flash`` and ``make monitor`` in one shoot type ``make flash monitor``. Check section :doc:`IDF Monitor <idf-monitor>` for handy shortcuts and more details on using this application.\r
 \r
+That's all what you need to get started with ESP32! \r
+\r
+Now you are ready to try some other :idf:`examples`, or go right to developing your own applications.\r
+\r
+\r
+Updating ESP-IDF\r
+================\r
+\r
+After some time of using ESP-IDF, you may want to update it to take advantage of new features or bug fixes. The simplest way to do so is by deleting existing ``esp-idf`` folder and cloning it again, exactly as when doing initial installation described in sections :ref:`get-started-get-esp-idf`.\r
+\r
+Another solution is to update only what has changed. This method is useful if you have slow connection to the GiHub. To do the update run the following commands::\r
+\r
+    cd ~/esp/esp-idf\r
+    git pull\r
+    git submodule update --init --recursive\r
+\r
+The ``git pull`` command is fetching and merging changes from ESP-IDF repository on GitHub. Then ``git submodule update --init --recursive`` is updating existing submodules or getting a fresh copy of new ones. On GitHub the submodules are represented as links to other repositories and require this additional command to get them onto your PC.\r
+\r
+If you would like to use specific release of ESP-IDF, e.g. `v2.1`, run::\r
+\r
+    cd ~/esp\r
+    git clone https://github.com/espressif/esp-idf.git esp-idf-v2.1\r
+    cd esp-idf-v2.1/\r
+    git checkout v2.1\r
+    git submodule update --init --recursive\r
+\r
+After that remember to :doc:`add-idf_path-to-profile`, so the toolchain scripts know where to find the ESP-IDF in it's release specific location.\r
+\r
 \r
 Related Documents\r
 =================\r