Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 96 lines (64 sloc) 4.519 kb
d8c49e8 moved stuff around in the readme
ilya authored
1 # Diaspora
fa4695c @jhass Revert "fix travis button"
jhass authored
2 [![Build Status](https://secure.travis-ci.org/diaspora/diaspora.png)](http://travis-ci.org/diaspora/diaspora)
d8c49e8 moved stuff around in the readme
ilya authored
3
4 The privacy aware, personally controlled, do-it-all, open source social
5 network.
6
34e9027 @maxwell update readme
maxwell authored
7 [Diaspora Foundation](http://diasporafoundation.org)
192218f @maxwell update readme language I did not care for; adding build status button fr...
maxwell authored
8
9 **TL;DR**
10
11 ## Are you a user?
12 You can get an account on any Diaspora pod(http://podup.sargodarya.de or http://dspr.tk/a for a list of pods), or sign up for an invite
13 at the pod run by the original development team at https://joindiaspora.com
14
15 ## Are you a developer?
16
17 Read on for how to get started.
18
a865373 Adjust readme
Raphael Sofaer authored
19 **THIS IS ALPHA SOFTWARE AND SHOULD BE TREATED ACCORDINGLY.**
20 **IT IS FUN TO GET RUNNING, BUT EXPECT THINGS TO BE BROKEN.**
d8c49e8 moved stuff around in the readme
ilya authored
21
2947a89 @danielgrippi put ?invite in the readme.
danielgrippi authored
22 ## Want an invite?
23
192218f @maxwell update readme language I did not care for; adding build status button fr...
maxwell authored
24 Diaspora is decentralized. You don't need an invite to joindiaspora.com to fully participate. Just choose your pod for example at http://podup.sargodarya.de 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
2947a89 @danielgrippi put ?invite in the readme.
danielgrippi authored
25
26 Even if you're not a programmer, we'd love for you to give Diaspora a spin; all suggestions and comments welcome!
27
28
3ea382e readme quick edit
ilya authored
29 ## Installation instructions
30
be8b16c ### looks bad
Raphael authored
31 Installation instructions are [here](http://github.com/diaspora/diaspora/wiki/Installing-and-Running-Diaspora).
d8c49e8 moved stuff around in the readme
ilya authored
32
3ea382e readme quick edit
ilya authored
33 Thanks for helping battle test Diaspora.
27a08b8 changed the bugs to the new place, testing jenkins receive hooks at the ...
Ilyaaaaaaaaaaaaa Zhitomirskiy authored
34 Please report any bugs you see at [GitHub Issues](https://github.com/diaspora/diaspora/issues).
d8c49e8 moved stuff around in the readme
ilya authored
35
674fbc0 Some readme modifications
Raphael authored
36 ## Contributing to Diaspora
2d7b72e Added a newline after headings where it was missing.
Pistos authored
37
250ef93 @danielgrippi make resource link references less wordy in readme.
danielgrippi authored
38 ###[An introduction to the source code](http://github.com/diaspora/diaspora/wiki/An-Introduction-to-the-Diaspora-Source)
ed56a4f @danielgrippi remove stray punctuation from readme.
danielgrippi authored
39 ###[Issue tracker (bugs and features)](https://github.com/diaspora/diaspora/issues)
250ef93 @danielgrippi make resource link references less wordy in readme.
danielgrippi authored
40 ###[How to use git](http://github.com/diaspora/diaspora/wiki/Git-Workflow)
dfb2408 couple of readme changes
zhitomirskiyi authored
41
42 Here are a few good places to start:
b370f4c adjust readme
Raphael authored
43
674fbc0 Some readme modifications
Raphael authored
44 - Run "rake spec" to run our [Rspec](http://blog.davidchelimsky.net/2007/05/14/an-introduction-to-rspec-part-i/)
4180d5d Take out rspec convention link
Raphael Sofaer authored
45 unit test suite.
b370f4c adjust readme
Raphael authored
46
674fbc0 Some readme modifications
Raphael authored
47 - Run "rake cucumber" to run our [Cucumber](http://rubylearning.com/blog/2010/10/05/outside-in-development/)
7a800a6 More rspec tests, maybe.
Raphael Sofaer authored
48 integration test suite.
b370f4c adjust readme
Raphael authored
49
27a08b8 changed the bugs to the new place, testing jenkins receive hooks at the ...
Ilyaaaaaaaaaaaaa Zhitomirskiy authored
50 - Take a look at the [issue tracker](https://github.com/diaspora/diaspora/issues) and pick a bug.
674fbc0 Some readme modifications
Raphael authored
51 Write a spec for it, so it's easy for another developer to fix it.
89f2cdd adjusting readme
Raphael authored
52
4815482 Start some real docs
Raphael Sofaer authored
53 Catches must be tested, and all your tests should be green,
674fbc0 Some readme modifications
Raphael authored
54 unless you're marking an existing bug, before a pull request is sent.
55 Unit tests should be in Rspec, and integration tests should be in Cucumber.
82e6e29 A small readme change
Raphael authored
56
674fbc0 Some readme modifications
Raphael authored
57 Please make your changes in a branch to ensure that new commits to your master are
58 not included in the pull request, and to make it easier for us to merge your commits.
e26ad0b topic branch
Raphael authored
59
d7bbb66 Run whitespace:cleanup
Raphael authored
60 Please do not rebase our tree into yours.
a2209d4 Add a link to authoritative rebase instructions
Raphael authored
61 See [here](http://www.mail-archive.com/dri-devel@lists.sourceforge.net/msg39091.html)
62 for when to rebase.
1d8d35c Add contributor agreement to readme
Raphael authored
63
a2209d4 Add a link to authoritative rebase instructions
Raphael authored
64 We need you to fill out a
524e4ba Update contributor agreement link
Raphael Sofaer authored
65 [contributor agreement form](https://spreadsheets.google.com/a/joindiaspora.com/spreadsheet/viewform?formkey=dFdRTnY0TGtfaklKQXZNUndsMlJ2eGc6MQ)
2aa9b33 Update wording for contributor agreement
Raphael Sofaer authored
66 before we can accept your patches. This dual license agreement allows
67 us to release limited pieces of Diaspora under the MIT license. You can find it
524e4ba Update contributor agreement link
Raphael Sofaer authored
68 [here](https://spreadsheets.google.com/a/joindiaspora.com/spreadsheet/viewform?formkey=dFdRTnY0TGtfaklKQXZNUndsMlJ2eGc6MQ).
a2209d4 Add a link to authoritative rebase instructions
Raphael authored
69
ea0d0cb link to tracker and wishlist
Daniel Vincent Grippi authored
70 ## Resources
71
27a08b8 changed the bugs to the new place, testing jenkins receive hooks at the ...
Ilyaaaaaaaaaaaaa Zhitomirskiy authored
72 Here is our [bug tracker](https://github.com/diaspora/diaspora/issues) and our
fa1e09c Hard-wrapped README text to confirm to an 80-character screen width.
Pistos authored
73 [roadmap](https://github.com/diaspora/diaspora/wiki/Roadmap). Also, you can
a865373 Adjust readme
Raphael Sofaer authored
74 find see what the core team is up to [here](http://www.pivotaltracker.com/projects/61641).
dfb2408 couple of readme changes
zhitomirskiyi authored
75
ea0d0cb link to tracker and wishlist
Daniel Vincent Grippi authored
76
77 Ongoing discussion:
7dc813a Added a newline before a list, so that the list can be properly interpre...
Pistos authored
78
e72b558 fixed links in readme. added description used in our blog.
Daniel Vincent Grippi authored
79 - [Diaspora Developer Google Group](http://groups.google.com/group/diaspora-dev)
80 - [Diaspora Discussion Google Group](http://groups.google.com/group/diaspora-discuss)
abf121f @patcito added link to diaspora Q&A shapado site
patcito authored
81 - [Diaspora Q&A site](http://diaspora.shapado.com/)
f1f2028 @denschub added getsatisfaction.com to readme. thanks, dkettler.
denschub authored
82 - [Diasproa on Get Satisfaction](http://getsatisfaction.com/diaspora/)
dcaa84f @jhass added #diaspora IRC channel to README.md
jhass authored
83 - [#diaspora IRC channel](irc://irc.freenode.net/#diaspora)
7ab287c @jhass forgot to add a link to the webchat
jhass authored
84 ([join via the web client](http://webchat.freenode.net?channels=diaspora))
5b6215d Replicating a bunch of Pistos' commits, because the HEADs diverged
Raphael authored
85 - [#diaspora-dev IRC channel](irc://irc.freenode.net/#diaspora-dev)
86 ([join via the web client](http://webchat.freenode.net?channels=diaspora-dev))
c60c803 made a quick set of instructions in the readme
Daniel Vincent Grippi authored
87
2a62792 @sarahmei Replace ref to github issues with link to redmine. Also, fussy copy edit...
sarahmei authored
88 More general info and updates about the project can be found on
6101f57 @maxwell fix a couple of broken links in our readme, thx dmorley
maxwell authored
89 [our blog](http://blog.joindiaspora.com),
86f462c Strip trailing whitespace.
Pistos authored
90 [and on Twitter](http://twitter.com/joindiaspora).
3e7d4b1 @jbhannah Fixed mailing list link typo in README.md.
jbhannah authored
91 Also, be sure to join the official [mailing list](http://eepurl.com/Vebk).
c60c803 made a quick set of instructions in the readme
Daniel Vincent Grippi authored
92
fa1e09c Hard-wrapped README text to confirm to an 80-character screen width.
Pistos authored
93 If you wish to contact us privately about any exploits in Diaspora you may
94 find, you can email
524e4ba Update contributor agreement link
Raphael Sofaer authored
95 [exploits@joindiaspora.com](mailto:exploits@joindiaspora.com), [corresponding public key (keyID: 77485064)](http://pgp.mit.edu:11371/pks/lookup?op=vindex&search=0xCC6CAED977485064).
Something went wrong with that request. Please try again.