Marius Vikhammer
38b0870fab
docs: self host docs
...
Move doc hosting from readthedocs to espressif servers
Update CI, Sphinx configs and add IDF Sphinx theme
2021-07-30 19:13:08 +08:00
Anton Maklakov
5487864df9
tools: Add a script for switching to real submodules in forks
2020-12-23 17:41:33 +07:00
krzychb
a556240e3e
Docs: Renamed download links to clearly state they are to download documentation. Fixed incorrectly linked documentation build badge.
2018-09-17 01:19:45 +00:00
Angus Gratton
ff2404a272
Merge branch 'master' into feature/cmake
2018-08-16 17:14:17 +10:00
Angus Gratton
ed8013ccc2
README: Add version-specific links
...
Make it clearer how the README fits in with the docs.
2018-08-09 11:07:39 +10:00
Angus Gratton
d0b8f2865f
docs: Switch base URL from esp-idf.readthedocs.io to docs.espressif.com
2018-06-19 11:23:33 +00:00
Angus Gratton
c7f19e76d7
docs: Move main docs to cover CMake
...
Add "GNU Make build system" doc with "cheat sheet" for moving to new system
2018-05-07 18:45:49 +08:00
krzychb
c8d8cdbf38
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-03-13 21:57:08 +01:00
Raphael Luba
05c4a76202
Fix reference to partition table documentation
...
… and link to it.
Signed-off-by: krzychb
2017-11-07 20:26:46 +01:00
Josh Lospinoso
e183897924
README: Converting URLs from HTTP to HTTPS
...
Merges https://github.com/espressif/esp-idf/pull/622
2017-08-30 17:55:00 +10:00
José Luis Aracil Gómez del Campo
554b77bd56
Update README.md, merges #706
...
Signed-off-by: krzychb <krzychb@gazeta.pl>
2017-06-19 22:41:56 +02:00
Xiaolong Zheng
33632aa29f
Update README.md
...
The link is broken
2017-05-02 17:17:54 -04:00
krzychb
1a19747678
Getting started guides
2017-04-27 19:51:42 +02:00
rudi ;-)
36e685580a
README: Remove link typo
...
link typo removed char > from end of the link
products/hardware/esp32/overview
Merges #439 https://github.com/espressif/esp-idf/issues/450
Closes #437 https://github.com/espressif/esp-idf/issues/437
2017-03-22 14:48:01 +08:00
Angus Gratton
1544544f8a
tools: New idf_monitor 'make monitor' tool for smarter monitor output
2017-03-13 09:31:45 +08:00
Angus Gratton
0eb5c06ad4
README: Add some tips on using menuconfig
2017-02-15 09:42:46 +11:00
Angus Gratton
7c7edab328
flash encryption/secure boot: Restructure documentation
...
Also add steps to disable flash encryption, as some people seem to
accidentally enable it.
Explicitly mark the flash encryption and secure boot as "READ DOCS
FIRST" in menuconfig.
2017-02-15 09:42:46 +11:00
Ivan Grokhotkov
1896381501
readme: fix link formatting
2017-01-17 01:17:20 +08:00
Ivan Grokhotkov
4b71d9cb35
docs: update index, improve structure of the readme
2017-01-16 02:38:31 +08:00
Angus Gratton
4f7314a760
README: Add a note about parallel builds
2017-01-03 10:59:11 +11:00
Angus Gratton
03551ec2da
build system: Add 'make monitor' target from arduino-esp32
...
Originally added to arduino-esp32 by @me-no-dev. It's so useful, we
want it in esp-idf as well! :)
2017-01-03 10:59:10 +11:00
Angus Gratton
59e0f63d37
Build system: Add make erase_flash target
2016-12-20 10:00:04 +11:00
Krzysztof
591b7caa95
Back to .md format
2016-11-01 01:20:04 +08:00
Krzysztof
41514f497a
Renamed .md to .rst
2016-11-01 01:20:04 +08:00
Angus Gratton
22e99694e3
Documentation: Add contributor guide, expand README & add an examples README
2016-09-27 10:38:00 +10:00
Angus Gratton
b9a853c903
README: Add Resources section with some links
2016-09-08 13:41:19 +10:00
Angus Gratton
14eb490bb3
make: 'make all' default target builds everything, 'make flash' flashes everything
...
Also added 'make help' target which prints some useful usage summary.
2016-08-18 21:42:37 +08:00
Angus Gratton
73001bcda2
Move details about partition tables to their own ReST doc in docs/
2016-08-18 21:42:37 +08:00
Angus Gratton
9e0c80688b
Fix gen_esp32part.py locations & documentation (thanks @wujiangang\!)
2016-08-18 21:42:37 +08:00
Ivan Grokhotkov
bd6ea4393c
Initial public version
2016-08-17 23:08:22 +08:00
