README.md 4.78 KB
Newer Older
ilya's avatar
ilya committed
1
# Diaspora
2

ilya's avatar
ilya committed
3
The privacy aware, personally controlled, do-it-all, open source social
4
network. [Diaspora Project](http://diasporaproject.org)
ilya's avatar
ilya committed
5

6 7 8 9 10 11 12
************************
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](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)
13 14 15 16

**TL;DR**

## Are you a user?
17
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
18 19 20 21 22 23
at the pod run by the original development team at https://joindiaspora.com

## Are you a developer?

Read on for how to get started.

Raphael Sofaer's avatar
Raphael Sofaer committed
24 25
**THIS IS ALPHA SOFTWARE AND SHOULD BE TREATED ACCORDINGLY.**
**IT IS FUN TO GET RUNNING, BUT EXPECT THINGS TO BE BROKEN.**
ilya's avatar
ilya committed
26

Daniel Grippi's avatar
Daniel Grippi committed
27 28
## Want an invite?

29
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 
Daniel Grippi's avatar
Daniel Grippi committed
30 31 32 33

Even if you're not a programmer, we'd love for you to give Diaspora a spin; all suggestions and comments welcome!


ilya's avatar
ilya committed
34 35
## Installation instructions

Raphael's avatar
Raphael committed
36
Installation instructions are [here](http://github.com/diaspora/diaspora/wiki/Installing-and-Running-Diaspora).
ilya's avatar
ilya committed
37

ilya's avatar
ilya committed
38
Thanks for helping battle test Diaspora.
39
Please report any bugs you see at [GitHub Issues](https://github.com/diaspora/diaspora/issues).
ilya's avatar
ilya committed
40

Raphael's avatar
Raphael committed
41
## Contributing to Diaspora
42

43
###[An introduction to the source code](http://github.com/diaspora/diaspora/wiki/An-Introduction-to-the-Diaspora-Source)
44
###[Issue tracker (bugs)](https://github.com/diaspora/diaspora/issues) - Currently going through major cleanup
45
###[How to use git](http://github.com/diaspora/diaspora/wiki/Git-Workflow)
zhitomirskiyi's avatar
zhitomirskiyi committed
46 47

Here are a few good places to start:
Raphael's avatar
Raphael committed
48

Raphael's avatar
Raphael committed
49
- Run "rake spec" to run our [Rspec](http://blog.davidchelimsky.net/2007/05/14/an-introduction-to-rspec-part-i/) 
50
unit test suite.
Raphael's avatar
Raphael committed
51

Raphael's avatar
Raphael committed
52
- Run "rake cucumber" to run our [Cucumber](http://rubylearning.com/blog/2010/10/05/outside-in-development/)
Raphael Sofaer's avatar
Raphael Sofaer committed
53
integration test suite.
Raphael's avatar
Raphael committed
54

55
- Take a look at the [issue tracker](https://github.com/diaspora/diaspora/issues) and pick a bug.
Raphael's avatar
Raphael committed
56
Write a spec for it, so it's easy for another developer to fix it.
Raphael's avatar
Raphael committed
57

Raphael Sofaer's avatar
Raphael Sofaer committed
58
Catches must be tested, and all your tests should be green, 
Raphael's avatar
Raphael committed
59 60
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.
Raphael's avatar
Raphael committed
61

Raphael's avatar
Raphael committed
62 63
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.
Raphael's avatar
Raphael committed
64

Raphael's avatar
Raphael committed
65
Please do not rebase our tree into yours.
66 67
See [here](http://www.mail-archive.com/dri-devel@lists.sourceforge.net/msg39091.html)
for when to rebase.
Raphael's avatar
Raphael committed
68

69
We need you to fill out a
70
[contributor agreement form](https://spreadsheets.google.com/a/joindiaspora.com/spreadsheet/viewform?formkey=dFdRTnY0TGtfaklKQXZNUndsMlJ2eGc6MQ)
71 72
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
73
[here](https://spreadsheets.google.com/a/joindiaspora.com/spreadsheet/viewform?formkey=dFdRTnY0TGtfaklKQXZNUndsMlJ2eGc6MQ).
74

75 76
## Resources

77
Here is our [bug tracker](https://github.com/diaspora/diaspora/issues) and our
78
[roadmap](https://github.com/diaspora/diaspora/wiki/Roadmap). Also, you can
Raphael Sofaer's avatar
Raphael Sofaer committed
79
find see what the core team is up to [here](http://www.pivotaltracker.com/projects/61641).
zhitomirskiyi's avatar
zhitomirskiyi committed
80

81 82

Ongoing discussion:
83

84 85
- [Diaspora Developer Google Group](http://groups.google.com/group/diaspora-dev)
- [Diaspora Discussion Google Group](http://groups.google.com/group/diaspora-discuss)
86
- [Diaspora Q&A site](http://diaspora.shapado.com/)
87
- [Diaspora on Get Satisfaction](http://getsatisfaction.com/diaspora/)
88
- [#diaspora IRC channel](irc://irc.freenode.net/#diaspora)
MrZYX's avatar
MrZYX committed
89
  ([join via the web client](http://webchat.freenode.net?channels=diaspora))
90 91
- [#diaspora-dev IRC channel](irc://irc.freenode.net/#diaspora-dev)
  ([join via the web client](http://webchat.freenode.net?channels=diaspora-dev))
92

93
More general info and updates about the project can be found on
94
[our blog](http://blog.joindiaspora.com),
Pistos's avatar
Pistos committed
95
[and on Twitter](http://twitter.com/joindiaspora).
96
Also, be sure to join the official [mailing list](http://eepurl.com/Vebk).
97

98 99
If you wish to contact us privately about any exploits in Diaspora you may
find, you can email
100
[exploits@joindiaspora.com](mailto:exploits@joindiaspora.com), [corresponding public key (keyID: 77485064)](http://pgp.mit.edu:11371/pks/lookup?op=vindex&search=0xCC6CAED977485064).