From 2c2cc9c1859332bf243fd640388b74fdb33fc9ea Mon Sep 17 00:00:00 2001 From: Daniel Vincent Grippi <Dan@SPEEDRACER.local> Date: Tue, 14 Sep 2010 16:10:31 -0700 Subject: [PATCH] atx-style headers --- README.md | 45 ++++++++++++++++++--------------------------- 1 file changed, 18 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 700a1e7f05..e73a01dfa8 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,12 @@ -Diaspora -======== +# Diaspora The privacy aware, personally controlled, do-it-all, open source social network. -Preparing your system ---------------------- - +## Preparing your system In order to run Diaspora for development, there are a few external dependencies in getting your environment set up: -- [Ruby](http://www.ruby-lang.org) - The Ruby programming language. __(We're using 1.8. Comes preinstalled on Mac OS X.)__ +- [Ruby](http://www.ruby-lang.org) - The Ruby programming language. (We're using 1.8. Comes preinstalled on Mac OS X.) - [MongoDB](http://www.mongodb.org) - A snappy noSQL database. - [OpenSSL](http://www.openssl.org/) - An encryption implementation. (Comes preinstalled on Mac OS X and later versions of Ubuntu.) - [ImageMagick](http://www.imagemagick.org/) - An Image processing library used to resize uploaded photos. @@ -18,40 +15,36 @@ In order to run Diaspora for development, there are a few external dependencies We suggest using a package management system to download these dependencies. Trust us, it's going to make your life a lot easier. If you're using Mac OS X, you can use [homebrew](http://mxcl.github.com/homebrew/); and if you're using Debian, just use Synaptic (it comes pre-installed). -After you have Ruby installed on your system, you will need to get Bundler. +After you have Ruby installed on your system, you will need to get Rubygems, then install Bundler: +- [RubyGems](http://rubygems.org/) - Source for Ruby gems. - [Bundler](http://gembundler.com/) - Gem management tool for Ruby projects. -Getting Diaspora ----------------- - +## Getting Diaspora To download Diaspora, you will want to clone it from the official github repository [here](http://github.com/diaspora/diaspora). If you have never used github before, their [help desk](http://help.github.com/) has a pretty awesome guide on getting setup[.](http://www.youtube.com/watch?v=OQSNhk5ICTI) -Running Diaspora ----------------- +## Running Diaspora -After installing the above, run the following command from where mongo is installed to start mongo. - sudo mongod +### Start Mongo +After installing the above, run `sudo mongod` from where mongo is installed to start mongo. + 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. -In order to start the app server for the first time, bundler needs to grab Diaspora's gem depencencies. To allow this, run the following command from Diaspora's root directory. - bundle install +### Install required gems +In order to start the app server for the first time, bundler needs to grab Diaspora's gem depencencies. To allow this, run `bundle install` from Diaspora's root directory. It is important to run a bundle install every so often, in the event of a new gem dependency. We will make sure to make an announcement in the event of a gem change. -Once mongo is running and bundler has finished, run: - bundle exec thin start -This will start the app server in development mode. +### Run the app server +Once mongo is running and bundler has finished, run `bundle exec thin start`. This will start the app server in development mode. -Diaspora's test suite uses [rspec](http://rspec.info/), a behavior driven testing framework. In order to run the tests, run the following command: - bundle exec rspec spec +### 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`. -Getting Help ------------- - +## Getting Help There are multiple outlets of ongoing discussion on the development of Diaspora. - [Diaspora Developer Google Group](http://groups.google.com/group/diaspora-dev) @@ -61,8 +54,7 @@ There are multiple outlets of ongoing discussion on the development of Diaspora. More general info and updates about the project can be found on our [blog](http://joindiaspora.com), [twitter](http://twitter.com/joindiaspora). Also, be sure to join the official [mailing list](http://http://eepurl.com/Vebk). -License -------- +## License Copyright 2010 Diaspora Inc. Diaspora is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. @@ -71,4 +63,3 @@ Diaspora is distributed in the hope that it will be useful, but WITHOUT ANY WARR You should have received a copy of the GNU Affero General Public License along with Diaspora. If not, see <http://www.gnu.org/licenses/>. - -- GitLab