Skip to content

Commit 50f3487

Browse files
ftrotterhuston
authored andcommitted
Update BUILD.md
1 parent 276dca4 commit 50f3487

1 file changed

Lines changed: 7 additions & 2 deletions

File tree

BUILD.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,17 @@ Build this repo locally
22
=======================
33
Alchemy.js leverages yeoman.io heavily for workflow. At the heart of Yeoman is the Gruntfile which is used to run tasks. The Alchemy.js app `./app` builds a `./dist` folder containing Alchemy.js and dependencies, while the Alchemy.js site is built from a seperate Yeoman project in the `./site` folder which publishes to the gh-pages branch of this repo. Additionally, we use [CoffeeScript](http://coffeescript.org), [Sass](http://sass-lang.com/), [d3](http://sass-lang.com/), and [lodash](http://lodash.com/). If you are looking to contribute, each project has fantastic documentation.
44

5-
##### Up and Running with Yeoman:
5+
##### Up and Running with Yeoman:
6+
(note, these instructions assume that you are running OSX. If you are running linux then you will not be using brew, instead use the package manager of your platform [Like yum or apt] to install, or install node from directly from the site. You will also need to have ruby installed in order for gem to work)
67
```
78
# If you don't have Node find fast Wifi
89
brew update
910
brew doctor
1011
brew install node
12+
```
13+
These instructions should work as long as you are using a *nix system and have node, npm, ruby and ruby development packages installed...
1114

15+
```
1216
# If you don't have Yeoman find fast Wifi
1317
npm install -g yo
1418
@@ -19,7 +23,7 @@ npm install -g coffee-script
1923
gem install compass
2024
2125
# Download this directory
22-
git clone git@github.com:GraphAlchemist/Alchemy.git
26+
git clone https://github.com/GraphAlchemist/Alchemy.git
2327
cd Alchemy
2428
```
2529

@@ -42,6 +46,7 @@ grunt serve
4246

4347
Alchemy will now be running at localhost:9000. The Alchemy app that is running is based on the inline configuration in `./app/index.html`. Additionally, there are a number of sample data sets to play with in the `./app/sample_data/` directory.
4448

49+
4550
Building the Docs
4651
-----------------
4752
One of the best ways to contribute is helping clean up the docs.

0 commit comments

Comments
 (0)