mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
Merge branch 'docs/esp8684_frontpages' into 'master'
docs: update frontpage/general pages for ESP8684 Closes IDF-4212 See merge request espressif/esp-idf!16455
This commit is contained in:
commit
95c34696c4
@ -1,5 +1,9 @@
|
||||
_Note that this is a template for an ESP-IDF example README.md file. When using this template, replace all these emphasised placeholders with example-specific content._
|
||||
|
||||
| Supported Targets | _Supported target, e.g. ESP32_ | _Another supported target, e.g. ESP32-S3_ |
|
||||
| ----------------- | ------------------------------ | ----------------------------------------- |
|
||||
|
||||
_If the example supports all targets supported by ESP-IDF then the table can be omitted_
|
||||
# _Example Title_
|
||||
|
||||
(See the README.md file in the upper level 'examples' directory for more information about examples.)
|
||||
|
@ -1,11 +1,3 @@
|
||||
languages
|
||||
contribute/contributor-agreement
|
||||
contribute/documenting-code
|
||||
contribute/creating-examples
|
||||
contribute/style-guide
|
||||
contribute/copyright-guide
|
||||
contribute/install-pre-commit-hook
|
||||
contribute/index
|
||||
api-guides/core_dump_internals
|
||||
api-guides/event-handling
|
||||
api-guides/performance/speed
|
||||
@ -74,13 +66,6 @@ api-guides/fatal-errors
|
||||
api-guides/memory-types
|
||||
api-guides/build-system-legacy
|
||||
api-guides/general-notes
|
||||
third-party-tools/platformio
|
||||
COPYRIGHT
|
||||
libraries-and-frameworks/libs-frameworks
|
||||
libraries-and-frameworks/index
|
||||
libraries-and-frameworks/cloud-frameworks
|
||||
versions
|
||||
gnu-make-legacy
|
||||
api-reference/api-conventions
|
||||
api-reference/template
|
||||
api-reference/provisioning/protocomm
|
||||
@ -216,8 +201,6 @@ api-reference/protocols/index
|
||||
api-reference/protocols/asio
|
||||
security/flash-encryption
|
||||
security/secure-boot-v2
|
||||
about
|
||||
resources
|
||||
get-started/establish-serial-connection
|
||||
get-started/macos-setup-scratch
|
||||
get-started/vscode-setup
|
||||
@ -230,4 +213,3 @@ get-started/linux-setup
|
||||
get-started/index
|
||||
get-started/windows-setup-update
|
||||
get-started/macos-setup
|
||||
index
|
||||
|
@ -86,7 +86,7 @@ Documentation
|
||||
ROM Source Code Copyrights
|
||||
==========================
|
||||
|
||||
ESP32, ESP32-S and ESP32-C Series SoCs mask ROM hardware includes binaries compiled from portions of the following third party software:
|
||||
ESP32, ESP8684, ESP32-S and ESP32-C Series SoCs mask ROM hardware includes binaries compiled from portions of the following third party software:
|
||||
|
||||
* :component:`Newlib <newlib>`, licensed under the BSD License and is Copyright of various parties, as described in :component_file:`COPYING.NEWLIB<newlib/COPYING.NEWLIB>`.
|
||||
|
||||
|
@ -23,12 +23,13 @@ About
|
||||
The {IDF_TARGET_NAME} is a 2.4 GHz Wi-Fi Bluetooth Low Energy combo SoC, which integrates a Xtensa® 32-bit LX7 CPU.
|
||||
|
||||
|
||||
.. only:: esp32c3
|
||||
.. only:: esp32c3 or esp8684
|
||||
|
||||
This is documentation of `ESP-IDF <https://github.com/espressif/esp-idf>`_, the framework to develop applications for {IDF_TARGET_NAME}.
|
||||
|
||||
The {IDF_TARGET_NAME} is a 2.4 GHz Wi-Fi Bluetooth Low Energy combo SoC, which integrates a 32-bit RISC-V RV32IMC single-core processor.
|
||||
|
||||
|
||||
.. figure:: ../_static/about-doc.png
|
||||
:align: center
|
||||
:alt: Espressif IoT Integrated Development Framework
|
||||
|
@ -183,7 +183,7 @@ or for specific target and language with::
|
||||
|
||||
build-docs -t esp32 -l en build
|
||||
|
||||
For more in-depth documentation about `esp-docs` features please see the `esp-doc` documentation.
|
||||
For more in-depth documentation about `esp-docs` features please see the documentation in the `esp-docs repository <https://github.com/espressif/esp-docs/blob/master/docs/building-documention.md>`_.
|
||||
|
||||
Wrap up
|
||||
-------
|
||||
|
@ -4,9 +4,9 @@ Install pre-commit Hook for ESP-IDF Project
|
||||
Required Dependency
|
||||
-------------------
|
||||
|
||||
Python 3.6.1 or above. This is our recommendation python version for IDF developers.
|
||||
Python 3.6.1 or above. This is our recommended python version for IDF developers.
|
||||
|
||||
If you still have python versions not compatible, please do not install pre-commit hook and update your python versions.
|
||||
If you still have python versions not compatible, update your python versions before installing the pre-commit hook.
|
||||
|
||||
Install pre-commit
|
||||
------------------
|
||||
|
@ -8,7 +8,7 @@ ESP-IDF Programming Guide
|
||||
|
||||
The function API documentation is excluded from the preview. Add docs_full label to the MR to generate the complete documentation.
|
||||
|
||||
This is the documentation for Espressif IoT Development Framework (`esp-idf <https://github.com/espressif/esp-idf>`_). ESP-IDF is the official development framework for the `ESP32, ESP32-S and ESP32-C Series SoCs <https://www.espressif.com/en/products/hardware/socs>`_.
|
||||
This is the documentation for Espressif IoT Development Framework (`esp-idf <https://github.com/espressif/esp-idf>`_). ESP-IDF is the official development framework for the `ESP32, ESP8684, ESP32-S and ESP32-C Series SoCs <https://www.espressif.com/en/products/hardware/socs>`_.
|
||||
|
||||
.. only:: html
|
||||
|
||||
|
@ -19,7 +19,7 @@ Useful Links
|
||||
|
||||
* A comprehensive collection of `solutions <https://github.com/espressif/esp-iot-solution#solutions>`_, `practical applications <https://github.com/espressif/esp-iot-solution#esp32-iot-example-list>`_, `components and drivers <https://github.com/espressif/esp-iot-solution#components>`_ based on ESP-IDF is available in `ESP IoT Solution <https://github.com/espressif/esp-iot-solution>`_ repository. In most of cases descriptions are provided both in English and in 中文.
|
||||
|
||||
* To develop applications using Arduino platform, refer to `Arduino core for ESP32 WiFi chip <https://github.com/espressif/arduino-esp32#readme>`_.
|
||||
* To develop applications using Arduino platform, refer to `Arduino core for the ESP32, ESP32-S2 and ESP32-C3 <https://github.com/espressif/arduino-esp32#readme>`_.
|
||||
|
||||
* Several `books <https://www.espressif.com/en/support/iot-college/books-new>`_ have been written about ESP32 and they are listed on `Espressif <https://www.espressif.com/en/support/iot-college/books-new>`__ web site.
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user