How to Contribute
-----------------
-Contributions to esp-idf - fixing bugs, adding features, adding documentation - are welcome. We accept contributions via [Github Pull Requests](https://help.github.com/articles/about-pull-requests/).
+Contributions to esp-idf - fixing bugs, adding features, adding documentation - are welcome. We accept contributions via `Github Pull Requests <https://help.github.com/articles/about-pull-requests/>`_.
Before Contributing
-------------------
* Are comments and documentation written in clear English, with no spelling or grammar errors?
-* If the contribution contains multiple commits, are they grouped together into logical changes (one major change per pull request)? Are any commits with names like "fixed typo" [squashed into previous commits](http://eli.thegreenplace.net/2014/02/19/squashing-github-pull-requests-into-a-single-commit/)?
+* If the contribution contains multiple commits, are they grouped together into logical changes (one major change per pull request)? Are any commits with names like "fixed typo" `squashed into previous commits <http://eli.thegreenplace.net/2014/02/19/squashing-github-pull-requests-into-a-single-commit/>`_?
* If you're unsure about any of these points, please open the Pull Request anyhow and then ask us for feedback.
Legal Part
----------
-Before a contribution can be accepted, you will need to sign our [Contributor Agreement](docs/contributor-agreement.rst). You will be prompted for this automatically as part of the Pull Request process.
+Before a contribution can be accepted, you will need to sign our :doc:`Contributor Agreement <docs/contributor-agreement>`. You will be prompted for this automatically as part of the Pull Request process.
-Using Espressif IoT Development Framework with the ESP32
-========================================================
+# Using Espressif IoT Development Framework with the ESP32
-|docs|
+[](http://esp-idf.readthedocs.io/en/latest/?badge=latest)
-Setting Up ESP-IDF
-------------------
+# Setting Up ESP-IDF
In the [docs](docs) directory you will find per-platform setup guides:
* [Mac OS Setup Guide](docs/macos-setup.rst)
* [Linux Setup Guide](docs/linux-setup.rst)
-Finding A Project
------------------
+# Finding A Project
-As well as the esp-idf-template_ project mentioned in the setup guide, esp-idf comes with some example projects in the [examples](examples) directory.
-
-.. _esp-idf-template: https://github.com/espressif/esp-idf-template
+As well as the [esp-idf-template](https://github.com/espressif/esp-idf-template) project mentioned in the setup guide, esp-idf comes with some example projects in the [examples](examples) directory.
Once you've found the project you want to work with, change to its directory and you can configure and build it:
-Configuring your project
-------------------------
+# Configuring your project
`make menuconfig`
-Compiling your project
-----------------------
+# Compiling your project
`make all`
... will compile app, bootloader and generate a partition table based on the config.
-Flashing your project
----------------------
+# Flashing your project
When `make all` finishes, it will print a command line to use esptool.py to flash the chip. However you can also do this from make by running:
You don't need to run `make all` before running `make flash`, `make flash` will automatically rebuild anything which needs it.
-Compiling & Flashing Just the App
----------------------------------
+# Compiling & Flashing Just the App
After the initial flash, you may just want to build and flash just your app, not the bootloader and partition table:
(There's no downside to reflashing the bootloader and partition table each time, if they haven't changed.)
-The Partition Table
--------------------
+# The Partition Table
Once you've compiled your project, the "build" directory will contain a binary file with a name like "my_app.bin". This is an ESP32 image binary that can be loaded by the bootloader.
In both cases the factory app is flashed at offset 0x10000. If you `make partition_table` then it will print a summary of the partition table.
-For more details about partition tables and how to create custom variations, view the `docs/partition_tables.rst` file.
+For more details about partition tables and how to create custom variations, view the `docs/partition-tables.rst` file.
-Resources
----------
+# Resources
-* The [docs directory of the esp-idf repository](docs) contains esp-idf documentation.
+* The [docs directory of the esp-idf repository](docs) contains source of [esp-idf](http://esp-idf.readthedocs.io/) documentation.
* The [esp32.com forum](http://esp32.com/) is a place to ask questions and find community resources.
* [Check the Issues section on github](https://github.com/espressif/esp-idf/issues) if you find a bug or have a feature request. Please check existing Issues before opening a new one.
-* If you're interested in contributing to esp-idf, please check the [CONTRIBUTING.md](CONTRIBUTING.md) file.
-
+* If you're interested in contributing to esp-idf, please check the [Contributions Guide](http://esp-idf.readthedocs.io/en/latest/contributing.html>).
-.. |docs| image:: https://readthedocs.org/projects/docs/badge/?version=latest
- :alt: Documentation Status
- :scale: 100%
- :target: http://esp-idf.readthedocs.io/en/latest/?badge=latest
\ No newline at end of file