]> granicus.if.org Git - esp-idf/commitdiff
1. Following https://esp32.com/viewtopic.php?f=14&t=3834 and https://github.com/espre...
authorkrzychb <krzychb@gazeta.pl>
Thu, 7 Dec 2017 21:45:39 +0000 (22:45 +0100)
committerIvan Grokhotkov <ivan@espressif.com>
Wed, 27 Dec 2017 08:54:17 +0000 (16:54 +0800)
docs/get-started/index.rst

index de1caa84c26b3026efecfff05809ca54c025a804..68c8f2ff0a39011e9957b2057269d11d1826350e 100644 (file)
@@ -127,10 +127,6 @@ ESP-IDF will be downloaded into ``~/esp/esp-idf``.
         cd ~/esp/esp-idf\r
         git submodule update --init\r
 \r
-.. note::\r
-\r
-    While cloning submodules on **Windows** platform, the ``git clone`` command may print some output starting ``': not a valid identifier...``. This is a `known issue <https://github.com/espressif/esp-idf/issues/11>`_ but the git clone still succeeds without any problems.\r
-\r
 \r
 .. _get-started-setup-path:\r
 \r
@@ -206,9 +202,6 @@ Here are couple of tips on navigation and use of ``menuconfig``:
 \r
     If you are **Arch Linux** user, navigate to ``SDK tool configuration`` and change the name of ``Python 2 interpreter`` from ``python`` to ``python2``.\r
 \r
-.. note::\r
-\r
-    Most ESP32 development boards have a 40MHz crystal installed. However, some boards use a 26MHz crystal. If your board uses a 26MHz crystal, or you get garbage output from serial port after code upload, adjust the :ref:`CONFIG_ESP32_XTAL_FREQ_SEL` option in menuconfig.\r
 \r
 .. _get-started-build-flash:\r
 \r
@@ -283,7 +276,18 @@ Several lines below, after start up and diagnostic log, you should see "Hello wo
     Restarting in 8 seconds...\r
     Restarting in 7 seconds...\r
 \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
+To exit the monitor use shortcut ``Ctrl+]``. \r
+\r
+.. note::\r
+\r
+    If instead of the messages above, you see a random garbage similar to::\r
+\r
+        e���)(Xn@�y.!��(�PW+)��Hn9a؅/9�!�t5��P�~�k��e�ea�5�jA\r
+        ~zY��Y(1�,1\15�� e���)(Xn@�y.!Dr�zY(�\ 6jpi�|�+z5Ymvp\r
+\r
+    or monitor fails shortly after upload, your board is likely using 26MHz crystal, while the ESP-IDF assumes default of 40MHz. Exit the monitor, go back to the :ref:`menuconfig <get-started-configure>`, change :ref:`CONFIG_ESP32_XTAL_FREQ_SEL` to 26MHz, then :ref:`build and flash <get-started-build-flash>` the application again.\r
+\r
+To execute ``make flash`` and ``make monitor`` in one go, 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