Commit Graph

78 Commits

Author SHA1 Message Date
radim.karnis
5d55d34481 docs: Update references to esptool docs 2021-11-24 10:28:39 +01:00
Lv Xin Yue
2059280445 Doc/add esp32s3 kevkitm 1 user guide cn and en 2021-11-17 11:13:34 +00:00
Roland Dobai
9c1d4f5b54 Build & config: Remove the "make" build system
The "make" build system was deprecated in v4.0 in favor of idf.py
(cmake). The remaining support is removed in v5.0.
2021-11-10 09:53:53 +01:00
Armando
d41da2792a doc: add flash and psram configuration doc in programming guide 2021-10-26 11:49:36 +08:00
Jakob Hasse
81e9266204 [examples]: removed hyphens
Replaced hyphens with underscores in examples
project definition for all examples which had
hyphens in their project name. dpp-enrollee is
an exceptions because the name matches the
project directory name while the project
directory also contains hyphens.
2021-10-09 13:58:24 +08:00
Juraj Sadel
85f9aa1062 docs: Instructions for Windows download optimization 2021-08-16 12:32:21 +02:00
Wang Ning
baebf74342 docs/add_esp32-s2-devkitc-1_user_guide 2021-07-30 14:00:45 +08:00
Wang Fang
8a6fa2f86c Merge branch 'docs/add_a_note_and_module_variants_to_esp32-devkitm-1_pico-devkitm-02u' into 'master'
Add a note to ESP32-DevKitM-1 User Guide, to enable single core mode
Add new module variants for ESP32-DevKitM-1 and ESP32-PICO-DevKitM-02 boards
Replace Ordering Information globally

Closes DOC-1620, DOC-1741, and DOC-1774

See merge request espressif/esp-idf!14479
2021-07-30 03:23:08 +00:00
Wang Fang
03669abead Add a note to ESP32-DevKtiM-1 User Guide, to enable single core mode
Add new module variants for ESP32-DevKitM-1 and ESP32-PICO-DevKitM-02 boards
Replace Ordering Information globally
2021-07-29 18:44:30 +08:00
daiziyan
ce916db7ed docs: update all documents in get started section and keep line number consistent 2021-07-22 15:54:47 +08:00
Marek Fiala
f6c2198a21 tools: Installing tools for given IDF_TARGET
Allow user to select specific ESP_TARGET while setting up ESD_IDF.
Only necessary tools for given target will be downloaded and installed.

Closes https://github.com/espressif/esp-idf/issues/5113
2021-07-16 15:03:19 +02:00
Lv Xin Yue
faee145a61 docs:add esp32-s3-devkitc-1 user guide 2021-07-02 15:21:07 +08:00
daiziyan
317ee67c2a docs: translate ESP32-S3 get started 2021-07-01 15:54:19 +08:00
Marius Vikhammer
638485b222 docs: updated getting started and other misc. guides for S3 2021-06-29 15:44:45 +08:00
Brian Alberto Ignacio Reyes
b630c45d91 docs: Fix vscode extension setup links 2021-04-23 20:45:24 +08:00
Wang Ning
424fe73a23 Add ESP32-C3-DevKitC-02 User Guide 2021-03-17 06:40:33 +00:00
Juraj Michálek
419673fa96 docs: add links to Windows installer 2.5 Offline and Online versions 2021-02-18 15:16:58 +01:00
Wang Ning
aa2b3e1b01 Add ESP32-C3-DevKitM-1 User Guide and updated ESP32C3_DOCS 2021-02-05 12:08:21 +08:00
Marius Vikhammer
548fd02d10 docs: initial update of programming guide for C3
Updates "front page" content, get-started, and api-guides with C3 content

Enable building and publishing of C3 docs in CI
2021-02-01 15:40:02 +08:00
Dai Zi Yan
703aef654b provide user guide for ESP32-DevKitM-1 2021-01-05 12:32:08 +08:00
Wang Fang
8dbd5a48a8 provide user guide for the development board ESP32-PICO-DevKitM-2 2020-12-14 18:26:44 +08:00
Ivan Grokhotkov
46cfc436ad Merge branch 'feature/idf_tools_github_mirror' into 'master'
Add GitHub mirror option for IDF tools installs

Closes IDF-2028

See merge request espressif/esp-idf!10616
2020-12-14 15:58:51 +08:00
Wang Fang
bdeb3a2fb6 upload user guide for development board: ESP32-PICO-KIT-1 2020-12-09 08:27:25 +00:00
Angus Gratton
291af6e766 tools: Use GitHub download URLs for all files that can be downloaded from GitHub 2020-12-03 17:50:42 +11:00
Angus Gratton
4a738721f1 idf_tools: Add option to replace all GitHub tools download URLs with dl.espressif.com
Via new IDF_GITHUB_ASSETS environment variable.
2020-12-03 17:49:37 +11:00
Ivan Grokhotkov
e9e6d970f3 Merge branch 'feature/add-shell-autocompletion' into 'master'
idf.py: Enable autocompletion for command idf.py

Closes IDF-1540

See merge request espressif/esp-idf!10742
2020-11-06 20:14:38 +08:00
Wang Ning
f87cbdee28 Add ESP32-S2-DevKitM-1 User Guide
Update 1 based on comments

Fix typo

Add annotation to UFL connector

Add UFL connector to description table
2020-11-06 00:50:33 +00:00
martin.gano
346b002d9a enable autocompletion for command idf.py 2020-11-03 23:27:58 +01:00
Wang Fang
00a99cfb9d docs: fix formatting issues in api-guides 2020-09-24 15:30:28 +08:00
Krzysztof
156fe090be docs: Add profile file name used by zsh shell 2020-09-11 00:33:48 +08:00
Krzysztof Budzynski
2d4e0a4496 docs: Add explanation of hello_world folder contents 2020-09-10 22:29:24 +08:00
Roland Dobai
23eadafd38 Fix the setup instructions in the main README 2020-09-07 16:06:05 +02:00
Soumesh Banerjee
22301653c6 VSCode Extension Setup Guide 2020-09-02 00:07:31 +08:00
Wang Fang
a5e5794059 docs: add a command to create an esp directory before cloning esp-idf 2020-08-31 09:12:21 +00:00
Krzysztof Budzynski
d16a17b01a docs: Add missing target setting in step 7 of Getting Started documentation 2020-08-28 20:23:17 +08:00
Marius Vikhammer
4d6030e03f doc: update chip features in getting started
Fixed number of cores for ESP32 and ESP32S2 being wrong.

Updated S2 to reflect that we have to ULP coprocessors

Closes IDFGH-3616
Closes https://github.com/espressif/esp-idf/issues/5556
2020-07-10 09:50:55 +08:00
Krzysztof Budzynski
7099c2b444 Merge branch 'doc/generate_idf_project_tags' into 'master'
doc: add generation of tags from sdkconfig and x_caps.h headers

Closes IDF-1484

See merge request espressif/esp-idf!8577
2020-05-20 23:46:47 +08:00
Kirill Chalov
2e5f983b5a Add user guides for ESP32-S2-Kaluga-1-Kit 2020-05-13 07:12:42 +00:00
Marius Vikhammer
fbb54184ef doc: add generation of tags from sdkconfig and x_caps.h headers
Also updates the way we handle exclude_patterns to use the new tags

Closes IDF-1484
2020-05-13 07:09:01 +00:00
Ivan Grokhotkov
01b3ffa8e3 docs: remove suggestion about running export.sh from .profile script
This was quite obviously a bad suggestion, and it seems that some
users have actually read the docs attentively enough to have followed
it. Replace be recommendation to create an alias.

Closes https://github.com/espressif/esp-idf/issues/3889
2020-04-29 23:43:14 +02:00
Fu Hanxi
5b2fa1a5ad build_app: make multi target support readable 2020-04-09 16:40:57 +08:00
Wang Ning
a0c37ae1bd Add ESP32-S2-Saola-1 User Guide 2020-03-26 18:40:05 +08:00
Wang Ning
b85358e593 Updated index
components/esp_wifi/lib_esp32/
2020-03-11 06:43:31 +08:00
Krzysztof Budzynski
2178e3fba4 docs: Update getting started guide for ESP32-S2 target 2020-03-05 05:05:23 +08:00
Kirill Chalov
1ead668d77 Issues with entering Download mode automatically
Add description to Getting started guides of possible issues preventing Development boards from entering Firmware Download mode automatically while trying to flash the boards

Closes https://jira.espressif.com:8443/browse/DOC-11
2020-03-04 04:58:29 +08:00
Roland Dobai
5c0cd9417d Docs: Encourage to used Python 3 2020-02-24 12:55:55 +01:00
Marius Vikhammer
1a90470f02 doc: Split HW-Reference into seperate files/folders for different chips 2020-02-07 16:37:44 +11:00
Marius Vikhammer
d56ea52ea1 doc: EN doc update and fixed warnings 2020-02-07 16:37:43 +11:00
Marius Vikhammer
9352899d69 doc: Update English pages with generic target name 2020-02-07 16:37:43 +11:00
Angus Gratton
9399f04da0 docs: Add 'toctree filter' directive & filter out ESP32-only pages from S2 docs 2020-02-07 16:37:43 +11:00