]> granicus.if.org Git - esp-idf/commitdiff
Added ReadTheDocs.org badges
authorKrzysztof <krzychb@gazeta.pl>
Sun, 23 Oct 2016 20:59:53 +0000 (22:59 +0200)
committerIvan Grokhotkov <ivan@espressif.com>
Mon, 31 Oct 2016 17:20:04 +0000 (01:20 +0800)
README.rst

index 65d616767346b879076bde1388639462f182d5b1..9711e22946bc61e6234fc61a73487812d416e6d0 100644 (file)
@@ -15,7 +15,9 @@ In the [docs](docs) directory you will find per-platform setup guides:
 Finding A Project
 -----------------
 
-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.
+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
 
 Once you've found the project you want to work with, change to its directory and you can configure and build it:
 
@@ -82,3 +84,9 @@ 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.
+
+
+.. |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