From 1eaa6a25e99579bb3b9cc8f5325529f43041d446 Mon Sep 17 00:00:00 2001 From: Sean Tilley Date: Tue, 20 Mar 2012 13:16:12 -0500 Subject: [PATCH] Give the README some tough love. --- README.md | 48 ++++++++++++++++++------------------------------ 1 file changed, 18 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 1d3618d7baf..c028d28d113 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Diaspora -The privacy aware, personally controlled, do-it-all, open source social +Welcome to the Diaspora project, the privacy aware, personally controlled, do-it-all, open source social network. [Diaspora Project](http://diasporaproject.org) ************************ @@ -8,56 +8,48 @@ Diaspora is currently going through a huge refactoring push, the code is changin If you want to do something big, reach out on IRC or the mailing list first, so you can contribute effectively <3333 ************************ +**THIS IS ALPHA SOFTWARE AND SHOULD BE TREATED ACCORDINGLY.** +**IT IS FUN TO GET RUNNING, BUT EXPECT THINGS TO BE BROKEN.** + [![Build Status](https://secure.travis-ci.org/diaspora/diaspora.png)](http://travis-ci.org/diaspora/diaspora) [![Dependency Status](https://gemnasium.com/diaspora/diaspora.png?travis)](https://gemnasium.com/diaspora/diaspora) **TL;DR** ## Are you a user? -You can get an account on any Diaspora pod(http://podupti.me or http://dspr.tk/a for a list of pods), or sign up for an invite +You can get an account on [many Diaspora pods](http://podupti.me), or sign up for an invite at the pod run by the original development team at https://joindiaspora.com ## Are you a developer? Read on for how to get started. -**THIS IS ALPHA SOFTWARE AND SHOULD BE TREATED ACCORDINGLY.** -**IT IS FUN TO GET RUNNING, BUT EXPECT THINGS TO BE BROKEN.** - -## Want an invite? - -Diaspora is decentralized. You don't need an invite to joindiaspora.com to fully participate. Just choose your pod for example at http://podupti.me or http://dspr.tk/a If you still want one have a look at https://github.com/diaspora/diaspora/wiki/Invitations Or setup your own pod - -Even if you're not a programmer, we'd love for you to give Diaspora a spin; all suggestions and comments welcome! +We need you to fill out a +[contributor agreement form](https://spreadsheets.google.com/a/joindiaspora.com/spreadsheet/viewform?formkey=dFdRTnY0TGtfaklKQXZNUndsMlJ2eGc6MQ) +before we can accept your patches. This dual license agreement allows +us to release limited pieces of Diaspora under the MIT license. You can find it +[here](https://spreadsheets.google.com/a/joindiaspora.com/spreadsheet/viewform?formkey=dFdRTnY0TGtfaklKQXZNUndsMlJ2eGc6MQ). -## Installation instructions +## Installation Guides -Installation instructions are [here](http://github.com/diaspora/diaspora/wiki/Installing-and-Running-Diaspora). +We have guides for pod admins (called podmins) [here](https://github.com/diaspora/diaspora/wiki/Installation-Guides). -Thanks for helping battle test Diaspora. -Please report any bugs you see at [GitHub Issues](https://github.com/diaspora/diaspora/issues). ## Contributing to Diaspora -###[An introduction to the source code](http://github.com/diaspora/diaspora/wiki/An-Introduction-to-the-Diaspora-Source) -###[Issue tracker (bugs)](https://github.com/diaspora/diaspora/issues) - Currently going through major cleanup -###[How to use git](http://github.com/diaspora/diaspora/wiki/Git-Workflow) +Information on contributing to the Diaspora project can be found on the wiki. You can check our [Issue tracker (bugs)](https://github.com/diaspora/diaspora/issues), learn how we [work with git](http://github.com/diaspora/diaspora/wiki/Git-Workflow), and [become more familiar with our system](https://github.com/diaspora/diaspora/wiki/Developers) -Here are a few good places to start: -- Run "rake spec" to run our [Rspec](http://blog.davidchelimsky.net/2007/05/14/an-introduction-to-rspec-part-i/) -unit test suite. -- Run "rake cucumber" to run our [Cucumber](http://rubylearning.com/blog/2010/10/05/outside-in-development/) -integration test suite. +Here are a few good places to start: - Take a look at the [issue tracker](https://github.com/diaspora/diaspora/issues) and pick a bug. Write a spec for it, so it's easy for another developer to fix it. Catches must be tested, and all your tests should be green, unless you're marking an existing bug, before a pull request is sent. -Unit tests should be in Rspec, and integration tests should be in Cucumber. +Unit tests should be in Rspec, Javascript tests should be in Jasmine, and integration tests should be in Cucumber. Please make your changes in a branch to ensure that new commits to your master are not included in the pull request, and to make it easier for us to merge your commits. @@ -66,11 +58,6 @@ Please do not rebase our tree into yours. See [here](http://www.mail-archive.com/dri-devel@lists.sourceforge.net/msg39091.html) for when to rebase. -We need you to fill out a -[contributor agreement form](https://spreadsheets.google.com/a/joindiaspora.com/spreadsheet/viewform?formkey=dFdRTnY0TGtfaklKQXZNUndsMlJ2eGc6MQ) -before we can accept your patches. This dual license agreement allows -us to release limited pieces of Diaspora under the MIT license. You can find it -[here](https://spreadsheets.google.com/a/joindiaspora.com/spreadsheet/viewform?formkey=dFdRTnY0TGtfaklKQXZNUndsMlJ2eGc6MQ). ## Resources @@ -88,10 +75,11 @@ Ongoing discussion: - [#diaspora-dev IRC channel](irc://irc.freenode.net/#diaspora-dev) ([join via the web client](http://webchat.freenode.net?channels=diaspora-dev)) -More general info and updates about the project can be found on +General info and updates about the project can be found on [our blog](http://blog.joindiaspora.com), +[our devblog](http://devblog.joindiaspora.com), [and on Twitter](http://twitter.com/joindiaspora). -Also, be sure to join the official [mailing list](http://eepurl.com/Vebk). +Also, be sure to join the official [mailing list](http://groups.google.com/group/diaspora-dev). If you wish to contact us privately about any exploits in Diaspora you may find, you can email