From 38133bbf19b4e43d90a32ac60294ae2250e2e208 Mon Sep 17 00:00:00 2001 From: alecz20 Date: Tue, 14 Mar 2017 16:19:37 -0400 Subject: [PATCH] Git dependency and alternate install Documented the dependency on Git and an alternate way to install using git and npm locally (solution from issue #45 --- README.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6b97fe5..5e8f745 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,13 @@ fixes all of this. ### Dependencies -Thor requires Node.js to be installed on your system. If you don't have Node.js -installed you can download it from http://nodejs.org or build it from the github -source repository: http://github.com/joyent/node. +Thor requires Node.js and Git to be installed on your system. +If you don't have Node.js installed you can download it from http://nodejs.org +or build it from the github source repository: http://github.com/joyent/node. +If you don't have Git install you can download and install it from +https://git-scm.com/downloads or using your operating system's package manager. -Once you have Node.js installed, you can use the bundled package manager `npm` to +Once you have Node.js and Git installed, you can use the bundled package manager `npm` to install this module: ``` @@ -22,6 +24,16 @@ npm install -g thor The `-g` command flag tells `npm` to install the module globally on your system. +An alternate way to install is to first clone the git package with git: +``` +git clone https://github.com/observing/thor.git +``` +then install with npm locally: +``` +cd thor/ +npm install -g . +``` + ### Usage ```