From 7c2cea74056f2b3d57f3680ecfb3435d4f3c4bee Mon Sep 17 00:00:00 2001 From: codestergit Date: Sun, 6 Dec 2015 01:06:37 +0530 Subject: [PATCH] Created HyperLink to sphinx in ReadMe.md for easy acess --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 382f43e296b26..b590ea6a79231 100644 --- a/README.md +++ b/README.md @@ -16,12 +16,12 @@ modules, eliminating the need for headers and the code duplication they entail. ## Documentation -To read the documentation, start by installing the Sphinx documentation -generator tool (http://sphinx-doc.org, just run `easy_install -U Sphinx` from -the command line and you're good to go). Once you have that, you can build the -Swift documentation by going into `docs` and typing `make`. This compiles -the `.rst` files in the `docs` directory into HTML in the `docs/_build/html` -directory. +To read the documentation, start by installing the +[Sphinx](http://sphinx-doc.org) documentation generator tool (just run +`easy_install -U Sphinx` from the command line and you're good to go). Once you + have that, you can build the Swift documentation by going into `docs` and +typing `make`. This compiles the `.rst` files in the `docs` directory into +HTML in the `docs/_build/html` directory. Once built, the best place to start is with the Swift white paper, which gives a tour of the language (in `docs/_build/html/whitepaper/index.html`).