alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
12,976 Commits 20 Branches 148 Tags 384 MiB
52496189d9
Commit Graph

31 Commits

Author SHA1 Message Date
Dai Zi Yan
37d8033906 update get-started/index.rst for release/v4.1 2020-12-11 11:38:37 +08:00
Krzysztof
3bca931923 docs: Add profile file name used by zsh shell 2020-10-09 19:16:59 +02:00
Roland Dobai
7da1603a1c Fix the setup instructions in the main README 2020-09-08 10:15:15 +02:00
Ivan Grokhotkov
f9bfc83295 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:34:00 +02:00
Roland Dobai
de3eed647f Docs: Encourage to used Python 3 2020-02-26 09:11:13 +01:00
Roland Dobai
bd2fc9f832 Make menuconfig colors configurable 
Closes https://github.com/espressif/esp-idf/issues/4387
 2019-11-26 10:40:34 +01:00
Andrei Gramakov
79dd142ab8 tools: add install.ps1, export.ps1 
Closes IDF-855
 2019-08-27 13:45:50 +08: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
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
Krzysztof
4e95b1ad21 Provide getting started guide for 'ESP32-Ethernet-Kit' board 2019-06-06 15:45:45 +08:00
liying
957301f293 add translation for devkitc guides and index files 2019-03-27 17:41:36 +00: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
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
Anton Maklakov
4a126e18ed docs: Correct Linux port names for more relevance 2018-10-21 15:11:45 +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
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
Darian Leung
d268677017 doc: Add environemt variable overriding to get started 
This comit adds details about the overriding of environment variables such as
ESPPORT and ESPBAUD to the get started guide.
 2018-09-05 02:05:31 +08:00
Roland Dobai
52d11dcfb0 docs: make the use of pip install clear 2018-08-23 11:41:56 +02:00
Roland Dobai
62cad3a7d7 Add python-future by using python requirements file 2018-08-23 08:28:57 +02:00
Angus Gratton
ffaa71bcd6 docs: Add version-specific include files, version documentation 
* "git clone" command and a small version header are generated
  depending on git properties.
* Add Versions page with details about each version
* Make it clear using master branch is living on the "bleeding
  edge"
 2018-08-06 15:38:32 +10:00
michael
3ba8461928 doc: fix the level inconsistent issue in Kconfig document 2018-06-05 10:36:18 +00:00
michael
d4deb9319a doc(global): build cross-language links for translated documents 2018-05-21 10:30:13 +08:00
Hrishikesh Dhayagude
d530036ad1 Fix few typos in the docs 
Signed-off-by: Hrishikesh Dhayagude <hrishi@espressif.com>
 2018-05-03 18:20:16 +05:30
Daniel Miller
32e0903561 doc: Spelling 
Merges https://github.com/espressif/esp-idf/pull/1798
 2018-04-09 12:28:15 +10:00
krzychb
40bc387bae Restored back original 'zh_CN' version files and updated links between versions 2018-03-13 21:57:08 +01:00
krzychb
097adc3a33 Moved files into separate folders per 'en' and 'zh_CN' language version and linked 'zh_CN' files back to 'en' files if translation is not yet available 2018-03-13 21:57:08 +01:00