Merge branch 'master' into fix/404-doc-link

README.md

@@ -1,6 +1,7 @@
 # ◤◣ prefab
 
 A tool to get prefabricated production ready code as a starter for your next adventure.
+---------------------------------------------------------------------------------------
 
 [![Build Status](https://travis-ci.com/yantrashala/prefab.svg?branch=master)](https://travis-ci.com/yantrashala/prefab)
 
@@ -10,7 +11,7 @@ If you want to use prefab as your app generator, simply install the prefab binar
 
 To contribute to the prefab source code or documentation, you should fork the prefab GitHub project and clone it to your local machine.
 
-Finally, you can install the prefab source code with go, build the binaries yourself, and run prefab that way. Building the binaries is an easy task for an experienced go getter.
+Finally, you can install the prefab source code with Go(programming language), build the binaries yourself, and run prefab that way. Building the binaries is an easy task for an experienced go getter.
 
 ### Install _prefab_ as Your Site Generator (Binary Install)
 
@@ -41,6 +42,7 @@ If you are a Windows user, substitute the `$HOME` environment variable above wit
 ## The _prefab_ Documentation
 
 TBD: links to documentation and tutorials
+Docker Overview https://www.tutorialspoint.com/docker/docker_overview.htm
 
 ## Getting started for _prefab_ Developers
 
@@ -95,7 +97,7 @@ TBD: links to documentation and tutorials
 
 ### or use chokidar for watch and recompile locally
 
-first install chokidar globally (assuming node & npm are alreadt installed)
+first install chokidar globally (assuming node & npm are already installed)
 
 ```
 > npm install -g chokidar-cli
@@ -127,3 +129,4 @@ first install chokidar globally (assuming node & npm are alreadt installed)
 5. Commit your changes (git commit -m 'Add some feature')
 6. Push to the branch (git push origin my-new-feature)
 7. Create new pull request
+8. Wait it to get reviewed and merged

docs/Readme.md

@@ -5,4 +5,39 @@
 * Introduction
 * Getting started
 * Tutorials
-* Reference
+* Reference
+* FAQ
+
+# ◤◣ prefab
+A tool to get prefabricated production ready code as a starter for your next adventure.
+
+[![Build Status](https://travis-ci.com/yantrashala/prefab.svg?branch=master)](https://travis-ci.com/yantrashala/prefab)
+## Choose How to Install
+If you want to use prefab as your app generator, simply install the prefab binaries. The prefab binaries have no external dependencies.
+
+To contribute to the prefab source code or documentation, you should fork the prefab GitHub project and clone it to your local machine.
+
+Finally, you can install the prefab source code with go, build the binaries yourself, and run prefab that way. Building the binaries is an easy task for an experienced go getter.
+
+### Install *prefab* as Your Site Generator (Binary Install)
+Use the installation [instructions in the prefab documentation]().
+TBD: steps to get release binary for different plaform
+
+### Build and Install the Binaries from Source (Advanced Install)
+
+#### Prerequisite Tools
+* [git client](https://git-scm.com/)
+* [Go (tested with 1.12)](https://goland.org/dl)
+
+#### Fetch from GitHub
+Prefab uses the Go Modules support built into Go 1.12 to build. The easiest is to clone prefab in a directory outside of GOPATH, as in the following example:
+
+```
+> mkdir $HOME/src
+> cd $HOME/src
+> git clone https://github.com/yantrashala/prefab.git
+> cd prefab
+> go run mage.go install
+```
+If you are a Windows user, substitute the `$HOME` environment variable above with `%USERPROFILE%`.
+