1
0
mirror of https://github.com/esp8266/Arduino.git synced 2025-07-27 18:02:17 +03:00

docs: convert to .rst and add readthedocs

This commit is contained in:
Ivan Grokhotkov
2017-02-19 16:55:37 +08:00
committed by Ivan Grokhotkov
parent 5c7247b0f4
commit 283eb97cd3
81 changed files with 7191 additions and 6324 deletions

View File

@ -1,38 +0,0 @@
using Eclipse with Arduino ESP8266
===========================================
### What to Download ###
- [arduino IDE](https://www.arduino.cc/en/Main/Software)
- [Eclipse IDE for C/C++ Developers](http://www.eclipse.org/downloads/packages/eclipse-ide-cc-developers/marsr)
- [Java](http://www.java.com/)
### Setup Arduino ###
see the [Readme](https://github.com/esp8266/Arduino#installing-with-boards-manager)
### Setup Eclipse ###
- [step 1](http://www.baeyens.it/eclipse/how_to.shtml#/c)
- [step 2](http://www.baeyens.it/eclipse/how_to.shtml#/e)
- go to Window --> preferences --> Arduino
- add as private hardware path the Part to the ESP8266
###### example private hardware path
Windows: C:\Users\[username]\AppData\Roaming\Arduino15\packages\esp8266\hardware
Linux: /home/[username]/.arduino15/packages/esp8266/hardware
### Eclipse wont build ###
if eclipse dont find the path to the Compiler add to the platform.txt
after:
```
version=1.6.4
```
this:
```
runtime.tools.xtensa-lx106-elf-gcc.path={runtime.platform.path}/../../../tools/xtensa-lx106-elf-gcc/1.20.0-26-gb404fb9
runtime.tools.esptool.path={runtime.platform.path}/../../../tools/esptool/0.4.4
```
Note:
- the path may changed, check the current version.
- each update over the Arduino IDE will remove the fix
- may not needed in future if Eclipse Plugin get an Update

53
doc/eclipse/eclipse.rst Normal file
View File

@ -0,0 +1,53 @@
Using Eclipse with Arduino ESP8266
==================================
What to Download
~~~~~~~~~~~~~~~~
- `arduino IDE <https://www.arduino.cc/en/Main/Software>`__
- `Eclipse IDE for C/C++
Developers <http://www.eclipse.org/downloads/packages/eclipse-ide-cc-developers/marsr>`__
- `Java <http://www.java.com/>`__
Setup Arduino
~~~~~~~~~~~~~
See the
`Readme <https://github.com/esp8266/Arduino#installing-with-boards-manager>`__
Setup Eclipse
~~~~~~~~~~~~~
- `step 1 <http://www.baeyens.it/eclipse/how_to.shtml#/c>`__
- `step 2 <http://www.baeyens.it/eclipse/how_to.shtml#/e>`__
- go to Window --> preferences --> Arduino
- add as private hardware path the Part to the ESP8266
example private hardware path
::
Windows: C:\Users\[username]\AppData\Roaming\Arduino15\packages\esp8266\hardware
Linux: /home/[username]/.arduino15/packages/esp8266/hardware
Eclipse wont build
~~~~~~~~~~~~~~~~~~
if eclipse dont find the path to the Compiler add to the platform.txt
after:
::
version=1.6.4
this:
::
runtime.tools.xtensa-lx106-elf-gcc.path={runtime.platform.path}/../../../tools/xtensa-lx106-elf-gcc/1.20.0-26-gb404fb9
runtime.tools.esptool.path={runtime.platform.path}/../../../tools/esptool/0.4.4
Note: - the path may changed, check the current version. - each update
over the Arduino IDE will remove the fix - may not needed in future if
Eclipse Plugin get an Update