Clarify where docs live
Dan Abramov committed
May 1, 2017 at 13:39 UTC
f217228326952d1f138cd49001cc458a0ec2a825
1 file changed
+9
-1
docs/README.md
+9
-1
@@ -1,11 +1,19 @@
1
# React Documentation & Website
2
3
-We use [Jekyll](http://jekyllrb.com/) to build the site using ([mostly](http://zpao.com/posts/adding-line-highlights-to-markdown-code-fences/)) Markdown, and we host it by pushing HTML to [GitHub Pages](http://pages.github.com/).
3
+## [Read the React Documentation](https://facebook.github.io/react/)
4
+
5
+This folder is not the right place to *read* the documentation.
6
+
7
+Instead, head over [to the React website](https://facebook.github.io/react/) to read it.
8
+
9
+This folder only contains the source code for the website.
10
11
## Installation
12
13
If you are working on the site, you will want to install and run a local copy of it.
14
15
+We use [Jekyll](http://jekyllrb.com/) to build the site using ([mostly](http://zpao.com/posts/adding-line-highlights-to-markdown-code-fences/)) Markdown, and we host it by pushing HTML to [GitHub Pages](http://pages.github.com/).
16
+
17
### Dependencies
18
19
In order to use Jekyll, you will need to have Ruby installed. macOS comes pre-installed with Ruby, but you may need to update RubyGems (via `gem update --system`).