Commit 604c1a8e authored by Sean Tilley's avatar Sean Tilley

Update Readme to be hella less sprawling [ci skip]

parent c1f2bbac
# Diaspora
## Welcome to the Diaspora Project!
Welcome to the Diaspora project, the privacy aware, personally controlled, do-it-all, open source social
network. [Diaspora Project](
Diaspora is a privacy-aware, personally-controlled, do-it-all open source social network. Check out our [project site](
[![Build Status](](
[![Dependency Status](](
Diaspora is currently going through a huge refactoring push, the code is changing fast!
If you want to do something big, reach out on IRC or the mailing list first, so you can contribute effectively <3333
[![Build Status](](
[![Dependency Status](](
## Are you a user?
You can get an account on [many Diaspora pods](, or sign up for an invite
at the pod run by the original development team at
## Are you a developer?
Read on for how to get started.
We need you to fill out a
[contributor agreement form](
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
## Installation Guides
We have guides for pod admins (called podmins) [here](
## Contributing to Diaspora
Information on contributing to the Diaspora project can be found on the wiki. You can check our [Issue tracker (bugs)](, learn how we [work with git](, and [become more familiar with our system](
Here are a few good places to start:
- Take a look at the [issue tracker]( and pick a bug.
Write a spec for it, so it's easy for another developer to fix it.
With Diaspora you can:
-Run and host your own pod and have control over your own social experience.
-Own your own data.
-Make friends across other pods seamlessly.
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, Javascript tests should be in Jasmine, and integration tests should be in Cucumber.
Documentation is available on our [wiki](
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.
## Quick Start:
Please do not rebase our tree into yours.
See [here](
for when to rebase.
Here's how you can get a development environment up and running. You can check out system-specific guides [here](
### Step 1: Clone the repo
```git clone
## Resources
### Step 2: Navigate to your cloned repository
```cd ../diaspora
Here is our [bug tracker]( and our
[roadmap]( Also, you can
find see what the core team is up to [here](
### Step 3: Install Bundler and gems (depending on [OS Vendor](
```sudo gem install bundler && sudo bundle install
### Step 4: Edit database.yml, and rename application.yml.example to just application.yml
Ongoing discussion:
### Step 5: Create and migrate the database
```rake db:create && rake db:migrate
- [Diaspora Developer Google Group](
- [Diaspora Discussion Google Group](
- [#diaspora IRC channel](irc://
([join via the web client](
- [#diaspora-dev IRC channel](irc://
([join via the web client](
### Step 6: Start the test server
```rails s
General info and updates about the project can be found on
[our blog](,
[our devblog](,
[and on Twitter](
Also, be sure to join the official [mailing list](
## Resources:
If you wish to contact us privately about any exploits in Diaspora you may
find, you can email
[](, [corresponding public key (keyID: 77485064)](
-[Podmin Resources](
-[Dev List](!forum/diaspora-dev)
-[Discuss List](!forum/diaspora-discuss)
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment