summaryrefslogtreecommitdiffstats
path: root/docs/setup.md
diff options
context:
space:
mode:
authorSamy Pessé <samypesse@gmail.com>2016-02-21 11:01:49 +0100
committerSamy Pessé <samypesse@gmail.com>2016-02-21 11:01:49 +0100
commit40f829ce54d6fe8c56c1005ed7229d198918acb9 (patch)
tree534b2ac9fd35afd8fe3251d4104aac26aa12ed13 /docs/setup.md
parente16b3e35f438014cb51fac84a500c8996d18658d (diff)
downloadgitbook-40f829ce54d6fe8c56c1005ed7229d198918acb9.zip
gitbook-40f829ce54d6fe8c56c1005ed7229d198918acb9.tar.gz
gitbook-40f829ce54d6fe8c56c1005ed7229d198918acb9.tar.bz2
Add docs for setup gitbook
Diffstat (limited to 'docs/setup.md')
-rw-r--r--docs/setup.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/docs/setup.md b/docs/setup.md
new file mode 100644
index 0000000..aaa0407
--- /dev/null
+++ b/docs/setup.md
@@ -0,0 +1,37 @@
+# Setup and Installation of GitBook
+
+Getting GitBook installed and ready-to-go should only take a few minutes.
+
+### GitBook.com
+
+[GitBook.com](https://www.gitbook.com) is an easy to use solution to write, publish and host books. It's best and easier solution for publishing your content and collaborate on it.
+
+It integrates well with the [GitBook Editor](https://www.gitbook.com/editor).
+
+### Local Installation
+
+##### Requirements
+
+Installing GitBook is easy and straight-forward, but there are a few requirements you’ll need to make sure your system has before you start.
+
+* NodeJS (v4.0.0 and above are adviced)
+* Windows, Linux, Unix, or Mac OS X
+
+##### Install with NPM
+
+The best way to install GitBook is via **NPM**. At the terminal prompt, simply run the following command to install GitBook:
+
+```
+$ npm install gitbook-cli -g
+```
+
+`gitbook-cli` is an utility to install and use multiple versions of GitBook on the same system. It will automatically install the required version to build a book.
+
+##### Using pre-releases
+
+`gitbook-cli` makes it easy to install and test other versions of GitBook with your book:
+
+```
+$ gitbook install beta
+```
+