Angus Gratton
6153026f22
doc: Fix broken Release page links when building a stable version
2020-05-20 11:32:53 +10:00
Ivan Grokhotkov
7fbfb1aa03
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-05-05 21:39:30 +02:00
liying
4131b51c16
Backport changes made in 6147 to release/4.0
2020-04-20 21:47:26 +08:00
Roland Dobai
2a4173e9a6
Docs: Encourage to used Python 3
2020-02-26 09:01:42 +01:00
Ivan Grokhotkov
008d2db20b
Merge branch 'bugfix/win_tools_installer_fixes_v4.0' into 'release/v4.0'
...
docs: Windows tools installer release v2.3 (v4.0)
See merge request espressif/esp-idf!7561
2020-02-18 16:24:21 +08:00
Ivan Grokhotkov
3f6f658532
docs: update version of IDF tools installer for windows to v2.3
2020-02-18 12:23:34 +11:00
Krzysztof
7eeaa62c49
docs: Update Eclipse installation instructions, ref. https://esp32.com/viewtopic.php?f=13&t=14237#p55468
2020-02-15 23:12:59 +08:00
Ivan Grokhotkov
6cbda6bd22
docs: update Windows tools installer link
2019-12-30 11:34:00 +01:00
Roland Dobai
46cb254f21
Docs: Update Debian & Ubuntu install prerequisites
...
Latest versions of apt-get don't install as much packages by default
as older ones. This fix adds some missing packages discovered for an OS
derived from the latest stable Debian. These packages exist for older
Debian derivatives as well (tested with Ubuntu 16.04 LTS).
Closes https://github.com/espressif/esp-idf/issues/4480
2019-12-17 13:38:22 +01:00
Ivan Grokhotkov
905fdbc1ad
docs: update get-started to use Tools Installer v2.1
2019-10-18 11:10:41 +02:00
Kirill Chalov
639687f92b
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs.
2019-07-23 17:45:41 +08:00
Angus Gratton
80e9faaf1c
docs: Move Legacy Get Started guide to the Related Documents section
2019-07-09 20:35:34 +10:00
Angus Gratton
9583c8d037
docs: Rephrase the warning about not requiring MSYS2 on Windows
2019-07-09 14:32:26 +10:00
Angus Gratton
05ac8cfb6d
docs: Update description for Eclipse+Cmake support not ready yet
2019-07-09 14:32:26 +10:00
Angus Gratton
222146845c
docs: Make CMake build system default, mark GNU Make as legacy option
...
All `-cmake` suffixes are removed
Where a GNU Make option is renamed, the `-legacy` suffix is used
2019-07-09 14:32:26 +10:00
Angus Gratton
62ed221daf
docs: Functional renaming commit for CMake-as-default
...
Rename all the files which will be edited substantially in the next commit, without changing their
contents
Docs will not build for this ocmmit.
This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which
is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-07-08 17:31:27 +10:00
Wang Fang
b24341a664
Merge make-related documents:
...
1. Moved get-started files, 7 documents in total, from get-started-cmake folder to hw-reference folder;
2. Deleted get-started files, 7 documents in total, in get-started folder;
3. Updated links in get-started-cmake/index.rst and in get-started/index.rst;
4. Modified descriptions for build system in these files.
2019-07-04 13:16:18 +08:00
Ivan Grokhotkov
0e6ffd08b7
docs: update msys environment links for esp32-2019r1 toolchain
2019-06-11 22:22:14 +08:00
Krzysztof
4e95b1ad21
Provide getting started guide for 'ESP32-Ethernet-Kit' board
2019-06-06 15:45:45 +08:00
Natasha
440c42693d
Add translation for ESP32-WROVER-KIT Getting Started Guides
2019-05-27 07:53:20 +08:00
Alexey Gerenkov
8c6a924cdf
sys_view: Adds processing scripts for heap & log traces
2019-04-01 19:31:45 +03:00
liying
957301f293
add translation for devkitc guides and index files
2019-03-27 17:41:36 +00:00
Kirill Chalov
a1c39e4a53
Doc/review get st wrover kit
2019-03-26 16:12:42 +08:00
Kirill Chalov
bae824439e
Doc/review get st pico
2019-03-26 16:11:11 +08:00
Kirill Chalov
49cca9288f
Update IDF getting started sections for make and cmake as well as IDF monitor…
2019-03-14 00:10:26 +08:00
Roland Dobai
f0194f2a5e
docs: Update package dependencies
...
Closes https://github.com/espressif/esp-idf/issues/2384
2019-03-07 14:46:59 +01:00
Angus Gratton
aa4a5668b0
Merge branch 'bugfix/add_missing_links_to_translation' into 'master'
...
Included missing links between English and Chinese documentation, where…
See merge request idf/esp-idf!4176
2019-01-30 11:32:15 +08:00
Anton Maklakov
1332d3ba9c
docs: Correct priorities in the PATH string
...
Fixes https://github.com/espressif/esp-idf/pull/2944
2019-01-28 11:28:55 +08:00
krzychb
f675334ebb
Included missing links between English and Chinese documentation, where translation into Chinese is available
2019-01-27 19:01:34 +01:00
krzychb
7fa8eb91dd
Small updates of wording
2019-01-24 19:50:55 +08:00
ShellAddicted
aa364961d0
docs(en): dialout-linux added specific command for Arch linux the correct group is 'uucp'
...
Merges https://github.com/espressif/esp-idf/pull/2940
2019-01-24 19:50:55 +08:00
Angus Gratton
88150cb9bb
docs: Make Getting Started (CMake) guides version-aware
...
Also clean up some changes in Chinese CMake guide which were not propagated from the English guide.
2018-12-21 19:13:20 +11:00
krzychb
29b1f86f16
Extended information on using pins of ESP-WROVER-KIT that are shared among peripherals. Inspired by https://esp32.com/viewtopic.php?f=12&t=6856 .
2018-11-29 16:56:49 +01:00
Renz Christian Bagaporo
1600c3144c
docs: add pyparsing install to setup guide
2018-11-22 22:09:43 +08:00
Prasad Alatkar
b1189e9645
Docs: Change makes Eclipse setup inline with Mac OS and Linux.
2018-11-19 12:15:53 +08:00
Natasha
be0123e10e
Feature/update board guides for headers
2018-11-12 09:15:29 +08:00
Ivan Grokhotkov
c8fe9f696c
docs: fix instructions for building toolchain on macOS
...
Closes https://github.com/espressif/esp-idf/issues/503
Closes https://github.com/espressif/esp-idf/issues/2607
2018-10-26 12:42:38 +08:00
Angus Gratton
b964f389db
Merge branch 'bugfix/gcc8_compatibility' into 'master'
...
gcc8 compatibility for master branch
See merge request idf/esp-idf!3481
2018-10-22 11:11:04 +08:00
Krzysztof Budzynski
46c2112400
Added CN version of 'Getting Started' guides for 'ESP32-DevKitC' and 'ESP-WROVER-KIT'
2018-10-22 09:10:58 +08:00
Anton Maklakov
4a126e18ed
docs: Correct Linux port names for more relevance
2018-10-21 15:11:45 +08:00
Angus Gratton
9509c7c1c1
docs: Recommend native 'cryptography' package on Linux as well
2018-10-18 09:56:16 +11:00
Angus Gratton
7313e39fde
Merge branch 'feature_add_path_tools_pr2410' into 'master'
...
add_path.sh: cmake: add tools folder to the path
See merge request idf/esp-idf!3344
2018-10-05 12:34:10 +08:00
Angus Gratton
319fa2264f
windows: Update MSYS2 environment, add Python requirements to setup script
2018-10-01 16:16:49 +10:00
Anton Maklakov
7c8d5d2782
docs, scripts: Correct the priority of the PATH setting
2018-09-27 14:55:37 +08:00
Ivan Grokhotkov
e1ac237169
Merge branch 'doc/fix_config_links' into 'master'
...
doc: Fix config links, add navigation lists to config items page
See merge request idf/esp-idf!3310
2018-09-25 18:23:24 +08:00
Ivan Grokhotkov
91fa1764e5
docs: generate toolchain download links
2018-09-20 18:53:14 +08:00
Angus Gratton
8721173109
doc: Replace :envvar: config links with :ref:
2018-09-19 17:27:48 +10:00
Ivan Grokhotkov
789855e71b
esp32: abort when running on single core chip in dual core mode
...
Ref. https://esp32.com/viewtopic.php?f=2&t=7307
2018-09-19 15:05:26 +08:00
Roland Dobai
c3d99dd2e4
Encourage to install python packages without administrative rights
...
Using 'sudo pip install' can cause a lot of problems because usually
there are a couple of Python interpreters installed. This fix encourages
developers to use `pip install --user` instead which is safer.
2018-09-11 08:54:37 +02:00
Roland Dobai
5eb452f72e
Add required Python packages
...
On some systems pip and setuptools are no longer installed as
dependencies of the python packages. This commit adds the requirement
for these packages.
2018-09-11 08:54:37 +02:00