Skip to content

Commit

Permalink
fixed more markdown style bugs in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
csmeder committed Apr 1, 2012
1 parent 7b86012 commit 1832e2d
Showing 1 changed file with 37 additions and 22 deletions.
59 changes: 37 additions & 22 deletions README.md
Expand Up @@ -3,43 +3,54 @@ NodeWorld

Usage
-----
* Install Node.js by following the instructions here http://howtonode.org/how-to-install-nodejs
* Clone the "NodeWorld" repository
$ git clone git@github.com:bnowel/NodeWorld.git
* Configure node.js

#### Install Node.js

By following the instructions here http://howtonode.org/how-to-install-nodejs

#### Clone the "NodeWorld" repository

$ git clone git@github.com:bnowel/NodeWorld.git

#### Configure node.js

$ cd NodeWorld
$ npm install
* Run main.js

#### Run main.js

$ node main.js

visit http://0.0.0.0:3000 in your browser


Contributing
============

Please update these intructions if you find an error

Setting up a local enviroment
-----------------------------
* Fork bnowel's "NodeWorld" repository through github
#### Fork bnowel's "NodeWorld" repository through github

* Clone your fork
#### Clone your fork

$ git clone git@github.com:<your github username>/NodeWorld.git

* Configure remotes
#### Configure remotes

$ cd NodeWorld
$ git remote add upstream git@github.com:bnowel/NodeWorld.git
$ git fetch upstream

* Install Node.js
#### Install Node.js

Follow the instructions here http://howtonode.org/how-to-install-nodejs

If you have OSX with home brew installed you can install node with the following command:

$ brew install node

* Configure Node.js
#### Configure Node.js

$ npm install

Expand All @@ -57,47 +68,51 @@ To start using mocha

Developing a new feature
------------------------
* Pick a feature from the issues page https://github.com/bnowel/NodeWorld/issues or come up with your own new feature.
* Get the latest from upstream before starting your feature
#### Choose your Feature to create
Pick a feature from the issues page https://github.com/bnowel/NodeWorld/issues or come up with your own new feature.

#### Get the latest from upstream before starting your feature

$ git branch master
$ git fetch upstream
$ git merge upstream/master

* Create a new branch to do develop your feature in
#### Create a new branch to do develop your feature in

$ git checkout -b fooBarFeature

* Write unit tests for your new feature
#### Write unit tests for your new feature

$ vim static/js/fooBar_test.js

* Commit your changes to your branch regularly
#### Commit your changes to your branch regularly

$ git commit -am "wrote unit tests for fooBar feature"

* Develop your feature and get your tests passing
#### Develop your feature and get your tests passing

$ vim static/js/fooBar.js

* Remember to commit your changes to your branch regularly
#### Remember to commit your changes to your branch regularly

$ git commit -am "started fooBar feature"

* Once your feature is tested and working merge any new upstream changes in and resolve any conflicts
#### Merge in upstream
Once your feature is tested and working merge any new upstream changes in and resolve any conflicts

$ git fetch upstream
$ git merge upstream/master

* If you have any merge confilcts address them
#### If you have any merge confilcts address them

$ git diff

* push your branch to your github repository
#### push your branch to your github repository

$ git push origin fooBarFeature

* Perform a pull request
#### Perform a pull request

visit github, navigate to your fooBarFeature branch and click on Pull

Bug Tracker
Expand Down

0 comments on commit 1832e2d

Please sign in to comment.