Commit Graph

40 Commits

Author SHA1 Message Date
pedro.minatel
f79411f3d3 Links to the new docs updated and new docs build badge added 2021-07-19 15:01:39 +01:00
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
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
Ivan Grokhotkov
0c3597f8d7
readme: minor fixes around chip names (#5097) 2021-04-21 18:55:58 +03:00
Me No Dev
fb0d63b576
Update README.md 2021-04-17 15:48:13 +03:00
lbernstone
aeb4a13aad
ESP32S2 pinmap (#5015) 2021-04-05 16:54:40 +03:00
Me No Dev
ad07d36932
Update README.md 2020-11-06 17:21:12 +02:00
Saptarsi Saha
b07f1c11fe
Updated Readme.md (#4400)
* Updated Readme.md

Added links to latest release. Made it look a lot cleaner.

* Update README.md
2020-10-14 14:26:41 +03:00
TechieZee
611ba8ea8a Update README.md (#3353) 2019-10-14 20:38:04 +03:00
me-no-dev
a5c873b786 Update README.md 2019-09-24 23:32:13 +03:00
me-no-dev
895a150840 Update README.md 2019-09-24 23:23:42 +03:00
Jason Cooke
1aced120ba docs: fix typo (#2973) 2019-07-09 19:14:27 +03:00
Me No Dev
f7cf583b87
Update README.md
Add download counter for releases
2019-01-11 10:17:45 +01: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
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
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
Fabian Affolter
1d4973a40b Fix heading (#412) 2017-06-02 18:21:54 +02:00
me-no-dev
2f02e27327 Update esptool on mac and windows and revert linux to use python 2017-04-04 02:36:55 +03:00
Ion
150d2cec69 Add hint (#170)
* Add hint

* Update README.md

* Update README.md

* Update README.md
2017-02-05 14:48:13 +02:00
Peter Lerup
4bae4e060b Added reference to makeEspArduino (#155) 2017-01-28 18:11:17 +02:00
Ivan Kravets
e5f6c2effa Initial version of build script for @PlatformIO; CI integration for Linux, macOS and Windows (#153)
* Initial version of build script for @PlatformIO; CI integration for Linux, macOS and Windows

* Remove CI badges
2017-01-28 14:19:56 +02:00
Me No Dev
73161688df Update README.md
Add Travis build badge
2017-01-28 14:15:42 +02:00
me-no-dev
4fbee226b6 move to binary esptool. Run get.py/get.exe to get it!
With this step we remove all dependencies, but git. Mac and Linux come
with Python by default, so they will keep using get.py to update the
toolchain and support binaries. Windows users have an "All point and
click" installation option that requires only git and Arduino to be
downloaded.
Fingers crossed :)
2017-01-19 15:58:29 +02:00
me-no-dev
93d2bc7f1e update get.py and add get.exe
- get.exe is clickable and will soon download binary form of esptool,
which will really simplify installation on Windows
- get.py does not require any extra modules on Linux and Mac
- ```pip install requests``` required only on Windows (if not using
get.exe)
- Paths are made relative to the file in order to make the windows
executable clickable.
2017-01-19 04:48:42 +02:00
Me No Dev
a2931e7a5b Update README.md
Add ```pip install requests``` to install steps
2017-01-19 01:49:48 +02:00
Murat Ambarkutuk
151f275ed1 Add brief explanation about app_main() function when arduino used as a esp-idf component (#99)
* Add brief explanation about app_main() function

* Update README.md

The proposed sentence is restated in a more clear way.

* Fix typo
2017-01-16 12:15:00 +02:00
me-no-dev
8e948096d4 Rename sd->sigmadelta in HAL
Change is to not be mistaken with SD Card
2017-01-09 17:57:17 +02:00
Me No Dev
22f0577339 Update README.md
Add exception decoder and fix layout
2017-01-05 17:59:20 +02:00
Me No Dev
4395efa3fc Update README.md 2016-12-30 03:00:57 +02:00
Me No Dev
7defc6ebf3 Update README.md 2016-12-13 13:45:58 +02:00
Murat Ambarkutuk
551e422423 Fix typos (#95) 2016-12-13 12:34:02 +02:00
The Gitter Badger
c336989e93 Add Gitter badge (#96) 2016-12-13 12:12:44 +02:00
Ivan Kravets
d8e74f2cbf Format README contents; add instructions for @PlatformIO (#88) 2016-12-10 18:28:24 +02:00
Me No Dev
ddb2541f5e Update README.md
Add instructions for using as IDF component
2016-12-09 00:34:28 +02:00
Me No Dev
13268b9d3c Update README.md
- Link to Windows instructions
- Update instructions for Linux and Mac
2016-12-07 00:46:43 +02:00
Me No Dev
af0cef4ec7 Update README.md 2016-10-07 11:32:35 +03:00
Me No Dev
efcd034622 Update README.md 2016-10-06 07:09:44 -06:00
me-no-dev
668acc2c08 repo init 2016-10-06 09:09:11 +03:00