Move esp-quick-toolchain info to esp8266 page and update.

SmingHub · Jul 16, 2024 · 150d585 · 150d585
1 parent 6e1e074
commit 150d585
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 36 deletions.
diff --git a/Sming/Arch/Esp8266/Components/libc/README.rst b/Sming/Arch/Esp8266/Components/libc/README.rst
@@ -4,4 +4,4 @@ Esp8266 LIBC Component
 .. highlight:: bash
 
 This Component supports integration of the standard C library provided by the compiler toolchain.
-See also :doc:`/arch/esp8266/getting-started/eqt`.
+See also :ref:`esp_quick_toolchain`.
diff --git a/Sming/Arch/Esp8266/README.rst b/Sming/Arch/Esp8266/README.rst
@@ -57,14 +57,44 @@ Weak hardware peripheral support
    hardware support for interfaces such as I2C and PWM is lacking and these must
    be implemented in software.
 
+.. _esp_quick_toolchain:
+
+ESP Quick Toolchain
+-------------------
+
+In Sming 4.0.1 support was added for the `ESP Quick Toolchain <https://github.com/earlephilhower/esp-quick-toolchain>`__.
+This is the required toolchain for compiling Sming for the Esp8266.
+
+At time of writing the current release is 
+`3.0.0-newlib4.0.0-gnu20 <https://github.com/earlephilhower/esp-quick-toolchain/releases/tag/3.0.0-newlib4.0.0-gnu20>`__
+for `GCC 10.2 <https://www.gnu.org/software/gcc/gcc-10>`__.
+
+The toolchain is consistent across development platforms which also use the
+standard C/C++ `NewLib <https://github.com/earlephilhower/newlib-xtensa>`__
+runtime libraries.
+
+
+Installation
+------------
+
+The easiest way to get started is with the Sming installer - see :doc:`/getting-started/index`.
+
+- Linux and MacOS: ``Tools/install.sh esp8266``.
+- Windows: ``Tools\install esp8266``.
+
 
 Configuration Variables
 -----------------------
 
 .. envvar:: ESP_HOME
 
    This contains the base directory for the toolchain used to build the framework.
-   See also :doc:`/arch/esp8266/getting-started/eqt`.
+   See :ref:`esp_quick_toolchain`.
+
+   The Sming installer extracts the toolchain to:
+
+   - ``/opt/esp-quick-toolchain`` for linux and MadOS
+   - ``C:\tools\esp-quick-toolchain`` for Windows
 
 
 Components

diff --git a/Sming/building.rst b/Sming/building.rst
@@ -75,8 +75,8 @@ These are the main variables you need to be aware of:
 
    The build standard applied for the framework.
 
-   This defaults to C++17 if the toolchain supports it (GCC 5+), C++11 otherwise.
-   You can override to use other standards, such as ``c++2a`` for experimental C++20 support.
+   C++17 is the minimum required standard.
+   You can override to use other standards, such as ``c++20``.
 
 
 These variables are available for application use:

diff --git a/docs/source/arch/esp8266/getting-started/eqt.rst b/docs/source/arch/esp8266/getting-started/eqt.rst
diff --git a/docs/source/upgrading/4.4-4.5.rst b/docs/source/upgrading/4.4-4.5.rst
@@ -27,7 +27,7 @@ For more information read the updated :doc:`/tools/eclipse`.
 Esp8266 toolchain
 -----------------
 
-Sming now requires the :doc:`/arch/esp8266/getting-started/eqt` for building.
+Sming now requires the :ref:`esp_quick_toolchain` for building.
 
 Support for the old legacy toolchains (ESP open SDK, UDK) have been dropped.
 They may still work but are no longer tested.