Commit Graph

44 Commits

Author SHA1 Message Date
Pedro Minatel
1effae46ea
Docs: Initial documentation structure using Sphinx (#5355)
This PR is the initial documentation structure including the basic information about the project and Sphinx configuration.

####CONTENTS:
- Getting Started
- Installing
- Boards
- Libraries
- Library Builder
- Tutorials
- ESP-IDF as Component
- OTA Web Update
- makeEspArduino
- Troubleshooting
- Contributing

This PR also changes the README.md.
2021-07-19 13:37:26 +03:00
Leziga
b1bcec08f8
Update boards_manager.md (#5296) 2021-06-16 20:58:31 +03:00
Pedro Minatel
23820874ec
Added the README template for examples and libraries (#5228)
Typos fixed and added more details and instructions
Added README file to WiFiScan example
Review on the README template
Added link to DevKits
2021-06-09 21:12:29 +03:00
Me No Dev
7f87d0fc3a
Fix compilation for use as IDF component (#5265) 2021-06-09 12:56:12 +03:00
Pedro Minatel
f385ee4219
Fixed labels on the boards pinouts images (#5213) 2021-06-09 12:33:12 +03:00
Pedro Minatel
cb2fbe445d
Added new boads pinout images for ESP32, ESP32-S2 and ESP32-C3 (#5133)
Board images updated and added warning on Flash/PSRAM pins
2021-05-18 13:33:57 +03:00
lbernstone
aeb4a13aad
ESP32S2 pinmap (#5015) 2021-04-05 16:54:40 +03:00
Dedik Serhii
5da4a47bdf
Update debian_ubuntu.md (#4907)
* Update debian_ubuntu.md

ERROR: This script does not work on Python 2.7 The minimum supported Python version is 3.6. Please use https://bootstrap.pypa.io/2.7/get-pip.py instead.

* Update debian_ubuntu.md

Co-authored-by: Me No Dev <me-no-dev@users.noreply.github.com>
2021-03-15 13:22:34 +02:00
Jorropo
c2346c37da
Add initial support for arm64 toolchain. (#4117)
Closes #4111.
gcc: I was not able to find an arm64 build on espressif's website so I choosed to put the armhf version, even if this should works this is only ok as temporary, arm64 runs better on arm64 than armhf :)
esptool: being interpreted python its ok
mkspiff: need igrr/mkspiffs#74 to be merged and artifacts added in /package/package_esp32_index.template.json.
2020-11-02 20:39:31 +02:00
lbernstone
1014ba40af
Update ISSUE_TEMPLATE.md (#4416)
Make options list into a table
2020-11-02 18:59:46 +02:00
Dimitre
c917ed2504
shallow clone to make installation faster (#4246)
shallow clone (board and submodules) to make installation faster
2020-10-01 14:43:48 +03:00
ducalex
7b613c1238
Added documentation regarding delay() resolution in esp-idf component (#3014) 2020-09-30 14:17:53 +03:00
lbernstone
e59355df71 Docs for lib builder (#3415)
* Docs for lib builder

* Typos and such
2019-11-11 15:30:52 +01:00
Me No Dev
048b26547a
Update boards_manager.md 2019-10-02 16:06:15 +03:00
Me No Dev
b10ed77aaf
Update boards_manager.md 2019-10-02 15:58:58 +03:00
Me No Dev
01d9345d28
Update development JSON location 2019-10-01 12:14:07 +03:00
Rotzbua
ee6336a312 links http -> https (#3010)
more secure
2019-08-20 16:47:43 +03:00
Amon Moce Rodolphe BAZONGO
2743e7b739 Update mac.md (#2745) 2019-05-11 11:21:25 +03:00
Tanishq Jasoria
00a546ee06 python2 get.py does not work behind proxy (#2349)
Executing python2 get.py behind proxy give error "IOError: [Errno socket error] [SSL: UNKNOWN_PROTOCOL] unknown protocol (_ssl.c:590)"
2019-01-22 17:28:27 +08:00
LynXzp
3a8ac27a86 layout fix (#1845)
(removed quotes from last line, and fixed indentation, no text changes)
2018-09-17 21:20:57 +02:00
lbernstone
6e4e4c96ee Updated ISSUE_TEMPLATE to try to get better postings (#1730)
* Updated ISSUE_TEMPLATE to try to get better postings

* Added line for PSRAM enabled

* More complete info request as per @stickbreaker
2018-09-17 21:11:41 +02:00
Eric
a989853d4a Update mac.md (#1760)
add a troubleshooting hint
2018-08-18 08:50:14 +02:00
Tokusei Noborio
7d3a67ada0 Update Arduino/hardware path (#1727) 2018-08-14 11:53:34 +02:00
lbernstone
a7ddf39521 Cleanup on README and boards_manager (#1693)
* Added instructions for installation with boards manager (stolen directly from esp8266)

* changed to production link instead of dev

* Added to main README. Made mods to images as requested.

* Added links for development package

* Moved version images to README.md

* Just a little change for cleaner look

* Cleaned up README.md and boards_manager.md to make installation easier.
2018-07-30 10:21:03 +03:00
lbernstone
2fba81223e Added instructions for installation with boards manager (#1630)
* Added instructions for installation with boards manager (stolen directly from esp8266)

* changed to production link instead of dev

* Added to main README. Made mods to images as requested.

* Added links for development package
2018-07-26 08:10:46 +02:00
Karan Sharma
0161e28614 Added OTAWebUpdater Doc (#1583) 2018-07-03 20:43:18 +02:00
lbernstone
c7b38008e2 Changed pinmap to show pins34-39 as GPI (#1510) 2018-06-19 11:34:05 +03:00
lbernstone
4ad27b4adc Added link to compilation issues for arduino as esp-idf component (#1435) 2018-05-25 16:27:50 +02:00
Marcel Stör
7bf1f47c97 Add note about sketch book location (#1374) 2018-05-14 13:04:44 +02:00
JP Liew
14ed6c4c25 Corrected Instructions for Windows typo error (#1210) 2018-04-06 19:12:17 +03:00
birgersp
77a8e47914 Changed Python version in Debian/Ubuntu install instructions (#1043)
As discussed in #1042.
2018-03-04 20:23:08 +01:00
Ivan Kravets
c8596cb9bb
Update integration with @PlatformIO 2018-02-05 13:00:31 +02:00
Vysakh P Pillai
81e0250983 Update windows.md (#946)
adding an additional step that is required to make sure the BLE libs are synced
2018-01-18 01:03:27 +02:00
Mark D
46d1b17319 doc typo (#889) 2017-11-28 13:53:33 +01:00
Ivan Kravets
aa83fca438 Update link to PIO Core (#877) 2017-11-28 11:10:36 +01:00
me-no-dev
823fb8fdbb Reword some instructions 2017-11-28 11:09:41 +01:00
Ted Timmons
2f73dd7920 add alternate location of this directory (#732) 2017-10-16 21:26:59 +03:00
Me No Dev
9fe32304c8 Update esp-idf_component.md 2017-10-14 00:08:41 +03:00
me-no-dev
409c75da04 Implement ESP_LOGx override option
Usable for library developers who write code not dependent on Arduino.
Adding 3 lines to the includes will permit their debug messages to be
visible in Arduino IDE or when enabled under IDF
2017-10-14 00:06:55 +03:00
Me No Dev
60b8b47455 Update IDF to de750e9 and add BLE (#723)
* Update IDF to de750e9

* Add BLE Library submodule
2017-10-13 22:07:41 +03:00
Me No Dev
cc00af38ec Update opensuse.md 2017-09-26 17:50:21 +08:00
joba1
dbf7b108f1 Update README.md with install instructions for openSUSE (#585)
* Update README.md

* Create opensuse.md
2017-09-26 17:49:18 +08:00
Rouan van der Ende
a7108969a3 Missing missing xcrun fix. (#601)
Had to run "xcode-select --install" before your script worked.
2017-08-31 15:56:47 +03:00
Pranav Cherukupalli
e6ba0f6281 DOCUMENTATION: Moved installation instructions to separate page (#561)
* DOCUMENTATION: Moved installation instructions to separate page

* Added Fedora to contents table
* Added Issue/Bug Report section to README
* Some minor improvements

* DOCUMENTATION: Rename directory doc to docs

* Also move ISSUE_TEMPLATE.md to docs directory

* DOCUMENTATION: Use current repo's files

* This makes it consistent instead  of having few local and few pointing to
  espressif/arduino-esp32 by all linking to local files

* DOCUMENTATION: Fix hyperlink to issue/bug template in contents

* DOCUMENTATION: contents: supress platform specific installation instruction
2017-08-17 16:14:01 +03:00