Commit Graph

251 Commits

Author SHA1 Message Date
Wang Ning
9246600b11 Docs: Updated ESP32-S2-DevKitM-1 User Guide for ECO1 2022-09-20 20:39:53 +08:00
Marius Vikhammer
8540e7a772 docs: fixed misc broken links 2022-09-18 15:03:39 +08:00
wangziyan
da9d7a257a docs: fix typos in get-started 2022-08-31 16:30:58 +08:00
Mo Fei Fei
62e968589f Docs: update cn translation for establish-serial-connection.rst 2022-08-31 12:43:25 +08:00
Zhang Tan
d21904fba9 docs: fix typo in get-started chapter 2022-08-24 23:48:54 +08:00
Michael (XIAO Xufeng)
ce80aae460 docs: update console frequency for ESP32-C2 2022-08-15 18:55:43 +00:00
Shang Zhou
a199f6f773 docs: provide CN translation for 18484 2022-08-09 09:52:07 +00:00
pedro.minatel
1df9480e29 Added procedures for the USB flashing
Link to the esptool page fixed and changes on the USB diagrams
Changes from MR review
2022-08-09 09:52:07 +00:00
jingli
209cb1f8ee docs: fix xtal kconfig related description 2022-08-05 19:12:29 +08:00
Anton Maklakov
80b97faade Merge branch 'docs/get_started_macos_rosetta' into 'master'
docs: add a suggestion for apple m1 users

Closes IDFGH-7758

See merge request espressif/esp-idf!18981
2022-07-27 10:03:48 +08:00
wangziyan
1f56072b3c docs: update the tips 2022-07-26 17:35:30 +08:00
wangziyan
b09b3bd5b1 docs: provide tips for Mac users 2022-07-26 15:29:44 +08:00
Anton Maklakov
57f231af82 docs: add a suggestion for apple m1 users
Closes: https://github.com/espressif/esp-idf/issues/9300
2022-07-26 11:14:05 +07:00
Wang Fang
c69908e976 docs: deleted IDE documentation and provided links to these IDE GitHub repos 2022-07-07 18:14:26 +08:00
Tomas Rezucha
11fd801ed9 docs: Add information about BSPs 2022-06-14 12:09:21 +02:00
Djordje Nedic
facab8c5a7 tools: Increase the minimal supported CMake version to 3.16
This updates the minimal supported version of CMake to 3.16, which in turn enables us to use more CMake features and have a cleaner build system.
This is the version that provides most new features and also the one we use in our latest docker image for CI.
2022-06-01 06:35:02 +00:00
Jiang Jiang Jian
3941b8d136 Merge branch 'docs/c2_getting_started' into 'master'
docs: update getting started guide for C2

Closes IDF-4211

See merge request espressif/esp-idf!18179
2022-05-30 10:53:15 +08:00
Roland Dobai
ed795c86df Tools: Use built-in venv instead of virtualenv for creating Python environments 2022-05-28 06:43:14 +00:00
Marius Vikhammer
7dcd85b873 docs: update getting started guide for C2 2022-05-28 14:22:13 +08:00
Marius Vikhammer
030e52f5d4 Merge branch 'feature/improve_doc_link_check' into 'master'
docs: fix broken links and re-enable linkchecker

Closes IDF-2640

See merge request espressif/esp-idf!17919
2022-05-19 15:52:17 +08:00
mofeifei
6b29118765 docs: sync up lines for api-guides and get-started 2022-05-09 02:10:06 +00:00
Marius Vikhammer
030cb77597 docs: update redirected links 2022-05-07 13:09:41 +08:00
mofeifei
cb64aebb3a docs: Review get started docs 2022-05-02 12:51:05 +02:00
Djordje Nedic
5250ca1627 docs: fix getting started having 2 toctrees
Instead of having 2 toctrees for setup and build your first project parts, use os-specific refs for the build your first project part
2022-05-02 11:37:19 +02:00
mofeifei
1a988b0b1e docs: improve sentences for wifi.rst 2022-04-24 02:14:07 +00:00
Wang Fang
e1ce61ea91 docs: updated hardware-related documents 2022-04-14 11:08:13 +08:00
Krzysztof Budzynski
6249b3d671 Merge branch 'bugfix/vscode_docs' into 'master'
docs: Update vscode-setup.rst, merges https://github.com/espressif/esp-idf/pull/8437

Closes IDFGH-6810

See merge request espressif/esp-idf!17269
2022-03-10 12:37:38 +08:00
daiziyan
9f4de1c9a5 docs: update CN translation for vscode-setup 2022-03-09 17:04:16 +08:00
Krzysztof
52595702b4 docs: fix link to VS Code debugging 2022-03-07 19:04:40 +08:00
Anton Maklakov
97c830aedf docs: fix mention of python version 2022-03-04 11:03:19 +07:00
Roland Dobai
7936a04c3e Tools: Make target-specific installation clearer in the getting started guide
Closes https://github.com/espressif/esp-idf/issues/8254
2022-02-28 17:18:23 +01:00
Andy Piper
e43277a3ba Update vscode-setup.rst
Improved formatting and grammar, fixed links so that they render correctly

Update docs/en/get-started/vscode-setup.rst

Typo

Co-authored-by: Krzysztof <krzychb@users.noreply.github.com>

fixes review comments (links, features list)
2022-02-24 17:48:45 +08:00
Mahavir Jain
39744f2e32 Fix regression in docs build failure 2022-02-20 14:15:43 +05:30
pedro.minatel
d049f30ad5 [Docs] Changes according to MR review 2022-02-17 10:50:59 +00:00
daiziyan
a4704d37e6 docs: updated CN translation for new get started 2022-02-17 10:50:59 +00:00
pedro.minatel
e4a766051c [Docs] Rebase conlicts fixed
[Docs] New getting started based on the ide and os selection
Missing file on zh_CN folder added
Added hidden toctree for missing files in CN version
docs: Added steps summary to the macOS procedures
[Docs] Changes on the titles and heading levels
[Docs] Review according to MR 15432
[Docs] Fixed the start a new project secction
2022-02-17 10:50:51 +00:00
Tomas Sebestik
fb12d03dc3 Drop Python 3.6 2022-02-10 07:20:52 +01:00
Ivan Grokhotkov
d2b894862c newlib: auto-detect sizeof(time_t)
To make the transition from 32-bit time_t to 64-bit time_t smoother,
detect the size of this type in CMake and remove the manual option in
Kconfig.
The information about 64-bit time_t support is moved from Kconfig help
string into the "system time" section of the API reference.
2022-01-11 19:01:21 +01:00
daiziyan
a98212015f docs:update CN transalation for get-started section and sdmmc 2021-12-21 18:43:56 +08:00
radim.karnis
5d55d34481 docs: Update references to esptool docs 2021-11-24 10:28:39 +01:00
Roland Dobai
460f3ad7b6 Merge branch 'feat/drop_msys' into 'master'
Tools: Remove MSYS/Mingw support

Closes IDF-3954

See merge request espressif/esp-idf!15862
2021-11-18 10:58:43 +00: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
a1d0d1ffbe Tools: Remove MSYS/Mingw support
MSYS/Mingw was deprecated since v4.0 and it is removed in v5.0. Please
follow the getting started guide of the documentation to set up a
Windows Command Line or Power Shell based environment.
2021-11-10 17:25:07 +01: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