Skip to content

Commit

Permalink
Added a newline after headings where it was missing.
Browse files Browse the repository at this point in the history
  • Loading branch information
Pistos committed Sep 21, 2010
1 parent 441f752 commit 2d7b72e
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions README.md
@@ -1,7 +1,8 @@
## Commit Guidlines

You are welcome to contribute, add and extend Diaspora however you see fit. We will do our best to incorporate everything that meets our guidelines.

We need you to fill out a [contributor agreement form](https://spreadsheets.google.com/a/joindiaspora.com/viewform?formkey=dGI2cHA3ZnNHLTJvbm10LUhXRTJjR0E6MQ&theme=0AX42CRMsmRFbUy1iOGYwN2U2Mi1hNWU0LTRlNjEtYWMyOC1lZmU4ODg1ODc1ODI&ifq) before we can accept your patches. The agreement gives Diaspora joint ownership of the patch so the copyright isn't scattered. You can find it [here](https://spreadsheets.google.com/a/joindiaspora.com/viewform?formkey=dGI2cHA3ZnNHLTJvbm10LUhXRTJjR0E6MQ&theme=0AX42CRMsmRFbUy1iOGYwN2U2Mi1hNWU0LTRlNjEtYWMyOC1lZmU4ODg1ODc1ODI&ifq).
We need you to fill out a [contributor agreement form](https://spreadsheets.google.com/a/joindiaspora.com/viewform?formkey=dGI2cHA3ZnNHLTJvbm10LUhXRTJjR0E6MQ&theme=0AX42CRMsmRFbUy1iOGYwN2U2Mi1hNWU0LTRlNjEtYWMyOC1lZmU4ODg1ODc1ODI&ifq) before we can accept your patches. The agreement gives Diaspora joint ownership of the patch so the copyright isn't scattered. You can find it [here](https://spreadsheets.google.com/a/joindiaspora.com/viewform?formkey=dGI2cHA3ZnNHLTJvbm10LUhXRTJjR0E6MQ&theme=0AX42CRMsmRFbUy1iOGYwN2U2Mi1hNWU0LTRlNjEtYWMyOC1lZmU4ODg1ODc1ODI&ifq).

All commits must be tested, and after each commit, all tests should be green before a pull request is sent. Please write your tests in Rspec.

Expand All @@ -14,7 +15,7 @@ The privacy aware, personally controlled, do-it-all, open source social network.
**DISCLAIMER: THIS IS PRE-ALPHA SOFTWARE AND SHOULD BE TREATED ACCORDINGLY.**
**PLEASE, DO NOT RUN IN PRODUCTION. IT IS FUN TO GET RUNNING, BUT EXPECT THINGS TO BE BROKEN**

Also, we really want to continue to focus on features and improving the code base. When we think it is
Also, we really want to continue to focus on features and improving the code base. When we think it is
ready for general use, we will post more detailed instructions.

## Notice
Expand All @@ -30,6 +31,7 @@ We will try and fully support more webservers later, but that is what works for
These instructions are for machines running [Ubuntu](http://www.ubuntu.com/), [Fedora](http://www.fedoraproject.org) or Mac OS X. We are developing Diaspora for the latest and greatest browsers, so please update your Firefox, Chrome or Safari to the latest and greatest.

## Preparing your system

In order to run Diaspora, you will need to download the following dependencies (specific instructions follow):

- Build Tools - Packages needed to compile the components that follow.
Expand Down Expand Up @@ -64,7 +66,7 @@ To install Ruby 1.8.7 on **Ubuntu**, run the following command:

sudo apt-get install ruby-full

Please note that you need to have Universe enabled in your /etc/apt/sources.list file to install ruby using apt-get.
Please note that you need to have Universe enabled in your /etc/apt/sources.list file to install ruby using apt-get.

At this time Fedora does not have Ruby 1.8.7. As a workaround it is possible to use [rvm](http://rvm.beginrescueend.com/) with a locally compiled Ruby installation. A semi automated method for doing this is available. It is highly recommended that you review the script before running it so you understand what will occur. The script can be executed by running the following command:

Expand All @@ -90,11 +92,11 @@ Then run:

You can also run the binary directly by doing the following:

If you're running a 32-bit system, run:
If you're running a 32-bit system, run:

wget http://fastdl.mongodb.org/linux/mongodb-linux-i686-1.6.2.tgz
If you're running a 64-bit system, run:

If you're running a 64-bit system, run:

wget http://fastdl.mongodb.org/linux/mongodb-linux-x86_64-1.6.2.tgz

Expand Down Expand Up @@ -202,9 +204,11 @@ If you have never used github before, their [help desk](http://help.github.com/)
## Running Diaspora

### Install required gems

To start the app server for the first time, you need to use Bundler to install Diaspora's gem depencencies. Run `bundle install` from Diaspora's root directory. Bundler will also warn you if there is a new dependency and you need to bundle install again.

### Start Mongo

If you installed the Ubuntu package, MongoDB should already be running (if not, run `service mongodb start`). If you installed the binary manually, run `sudo mongod` from where mongo is installed to start mongo.

If you installed the Fedora package, MongoDB will need to be started via `service mongodb start`. If you installed the binary manually, run `sudo mongod` from where Mongo is installed to start Mongo.
Expand All @@ -214,19 +218,24 @@ If you installed the OsX package through "brew", MongoDB will need to be started
Diaspora will not run unless Mongo is running. Mongo will not run by default, and will need to be started every time you wish to use or run the test suite for Diaspora.

### Run the server

`./script/server` will start both thin and the websocket server. If you want to run a different app server, you will have to run them separately. See below for instructions.

### Run the app server

Once mongo is running and bundler has finished, run `bundle exec thin start` from the root Diaspora directory. This will start the app server in development mode[.](http://bit.ly/9mwtUw)

### Run the websocket server

run `bundle exec ruby ./script/websocket_server` to start the websocket server on port 8080. Change the port in config/app_config.yml.

### Logging in with a sample user

Run `rake db:seed:tom`, then login with user `tom` and password `evankorth`. More details in db/seeds/tom.rb.


### Testing

Diaspora's test suite uses [rspec](http://rspec.info/), a behavior driven testing framework. In order to run the tests, run `bundle exec rspec spec`.

## Resources
Expand Down

0 comments on commit 2d7b72e

Please sign in to comment.