Commit Graph

184 Commits

Author SHA1 Message Date
Dai Zi Yan
97ec83fa78 Provide CN translation for get-started section in MR12242 2021-02-18 15:16:58 +01: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
Roland Dobai
47f67f8b81 tools: Prefer python3 during install and export
Install and export script should work on systems without "python"
executable.

Closes https://github.com/espressif/esp-idf/pull/6471

Closes https://github.com/espressif/esp-idf/issues/6532

Related to https://github.com/espressif/esp-idf/issues/6421 and
https://github.com/espressif/arduino-esp32/issues/4717
2021-02-13 11:34:40 +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
Krzysztof Budzynski
9a5bd86d54 Merge branch 'docs/update_docs_based_on_the_second_batch_of_customer_feedbacks' into 'master'
docs: update documents based on doc-855, doc-885, doc-889, doc-897

See merge request espressif/esp-idf!12124
2021-01-26 16:21:26 +08:00
Wang Fang
4c31cf9804 docs: Update FreeRTOS version, add tips to set up instructions for Windows 2021-01-26 03:46:25 +00:00
Wang Fang
7df1cad1d6 docs: This MR does the following updates:
1. Provided more information regarding I2S_COMM_FORMAT_STAND_PCM_SHORT and I2S_COMM_FORMAT_STAND_PCM_LONG
2. Added --output flag for partition table read instructions
3. Reordered the header files for esp-ble-mesh
4. Reordered the setup instructions for Ubuntu and CentOS
2021-01-25 11:10:08 +00:00
Ivan Grokhotkov
76acc8ddde Merge branch 'feature/win_inst_embedded_python' into 'master'
tools: support for embedded Python

Closes IDF-322

See merge request espressif/esp-idf!11682
2021-01-18 16:54:47 +08:00
Juraj Michálek
1427b3a6d8 tools: support for embedded python 2021-01-18 08:10:56 +01:00
Angus Gratton
e2910d2ff5 doc: Add libusb package dependencies for Arch, CentOS
- Arch uses 'libusb' package, provides libusb-1.0.so
- CentOS has moved to 'libusbx', which is libusb-1 API compatible

Related to https://github.com/espressif/esp-idf/issues/4095
2021-01-13 05:15:27 +00:00
mjdr
f12544a04e doc: Add libusb dependency for Ubuntu
Patch from https://github.com/espressif/esp-idf/pull/4669

Closes https://github.com/espressif/esp-idf/issues/4095
Related to https://github.com/espressif/esp-idf/issues/5181
2021-01-13 05:15:27 +00:00
Dai Zi Yan
703aef654b provide user guide for ESP32-DevKitM-1 2021-01-05 12:32:08 +08:00
Wang Fang
cf505d0ead docs: update the documents based on customer feedbacks 2020-12-31 05:40:43 +00: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
Krzysztof Budzynski
5f5ae17bc8 Merge branch 'feature/python2-deprecation-warn' into 'master'
Tools: Add Python 2 deprecation warning

Closes IDF-1677

See merge request espressif/esp-idf!11115
2020-12-02 19:26:46 +08:00
daiziyan
33c414087b add CN translation for adding python2 deprecation warning(MR 11115) 2020-12-02 11:11:57 +01:00
martin.gano
f4ea2dcb74 Tools: add Python 2 deprecation warning 2020-12-02 11:08:48 +01:00
daiziyan
62f7a1b545 fix merge conflicts 2020-12-02 16:50:07 +08:00
Juraj Michálek
5a2d84324d docs: add ESP-IDF Windows Installation limitations. 2020-12-01 07:33:47 +01:00
Dai Zi Yan
c7bebb0413 Doc/update CN translation for files on setting up toolchain from scratch in get started 2020-11-30 17:58:27 +08:00
Dai Zi Yan
c2818e775c Updated CN translation for index.rst and establish-serial-connection.rst and add CN translation for VScode-setup.rst in get-started folder to get EN and CN translation in sync 2020-11-25 14:45:26 +08: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
Krzysztof Budzynski
077bbb8647 docs: Clarify how to establish a serial connection to the device using macOS 2020-10-15 15:26:46 +08:00
Wang Fang
00a99cfb9d docs: fix formatting issues in api-guides 2020-09-24 15:30:28 +08:00
Krzysztof Budzynski
4547c0876a Merge branch 'feature/guide_change_for_catalina' into 'master'
docs: Add profile file name used by zsh shell

Closes DOC-325

See merge request espressif/esp-idf!10320
2020-09-11 16:42:30 +08:00
Krzysztof
b686e7d349 doc: Getting Started Guide, remove shortcuts to 'build toolchain from scratch' instructions 2020-09-11 01:43:21 +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
Wang Fang
12c91ee362 Update the description to reflect Python3 as the default interpreter DOC-258 2020-08-11 20:43:31 +08:00
yiying
0cca898e19 docs: change redirection link in get-started
This link is supposed to go to Step 3, but it goes to Step 2.
2020-07-22 16:19:11 +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
Angus Gratton
ee8796b169 Merge branch 'bugfix/doc_version_links' into 'master'
doc: Fix broken Release page links when building a stable version

See merge request espressif/esp-idf!8819
2020-05-20 13:16:46 +08:00
Angus Gratton
fdfb029711 doc: Fix broken Release page links when building a stable version 2020-05-20 10:50:44 +10:00
Krzysztof
789c42abcd Add another case and recomendation to use Python 3 instead of Python 2 2020-05-13 21:57:51 +02: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
Wang Ning
8b8d03f7bd Update Build and Flash with Eclipse IDE to make terminology consistent 2020-05-11 16:51:30 +08:00
Ivan Grokhotkov
a9c7db135d Merge branch 'bugfix/get_started_export_profile' into 'master'
docs: remove suggestion about running export.sh from .profile script

Closes IDFGH-1640

See merge request espressif/esp-idf!8320
2020-05-04 15:46:24 +08:00