143 lines
No EOL
6 KiB
HTML
143 lines
No EOL
6 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<title>
|
|
File: README
|
|
|
|
— Documentation by YARD 0.7.1
|
|
|
|
</title>
|
|
|
|
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
|
|
|
|
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
|
|
|
|
<script type="text/javascript" charset="utf-8">
|
|
relpath = '';
|
|
if (relpath != '') relpath += '/';
|
|
</script>
|
|
|
|
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
|
|
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
|
|
|
|
</head>
|
|
<body>
|
|
<script type="text/javascript" charset="utf-8">
|
|
if (window.top.frames.main) document.body.className = 'frames';
|
|
</script>
|
|
|
|
<div id="header">
|
|
<div id="menu">
|
|
|
|
<a href="_index.html" title="Index">Index</a> »
|
|
<span class="title">File: README</span>
|
|
|
|
|
|
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
</div>
|
|
|
|
<div id="search">
|
|
|
|
<a id="class_list_link" href="#">Class List</a>
|
|
|
|
<a id="method_list_link" href="#">Method List</a>
|
|
|
|
<a id="file_list_link" href="#">File List</a>
|
|
|
|
</div>
|
|
<div class="clear"></div>
|
|
</div>
|
|
|
|
<iframe id="search_frame"></iframe>
|
|
|
|
<div id="content"><div id='filecontents'><h1>Diaspora</h1>
|
|
|
|
<p>The privacy aware, personally controlled, do-it-all, open source social
|
|
network.</p>
|
|
|
|
<p><strong>THIS IS ALPHA SOFTWARE AND SHOULD BE TREATED ACCORDINGLY.</strong>
|
|
<strong>IT IS FUN TO GET RUNNING, BUT EXPECT THINGS TO BE BROKEN.</strong></p>
|
|
|
|
<h2>Installation instructions</h2>
|
|
|
|
<p>Installation instructions are <a href="http://github.com/diaspora/diaspora/wiki/Installing-and-Running-Diaspora">here</a>.</p>
|
|
|
|
<p>Thanks for helping battle test Diaspora.
|
|
Please report any bugs you see at <a href="http://bugs.joindiaspora.com">bugs.joindiaspora.com</a>.</p>
|
|
|
|
<h2>Contributing to Diaspora</h2>
|
|
|
|
<p>You can find an introduction to the source code <a href="http://github.com/diaspora/diaspora/wiki/An-Introduction-to-the-Diaspora-Source">here</a>.
|
|
Bugs and pending features are on our <a href="http://bugs.joindiaspora.com">issue tracker</a>.
|
|
A step-by-step guide to development using git can be found <a href="http://github.com/diaspora/diaspora/wiki/Git-Workflow">here</a>.</p>
|
|
|
|
<p>Here are a few good places to start:</p>
|
|
|
|
<ul>
|
|
<li><p>Run "rake spec" to run our <a href="http://blog.davidchelimsky.net/2007/05/14/an-introduction-to-rspec-part-i/">Rspec</a>
|
|
unit test suite.</p></li>
|
|
<li><p>Run "rake cucumber" to run our <a href="http://rubylearning.com/blog/2010/10/05/outside-in-development/">Cucumber</a>
|
|
integration test suite. As you can see, we need more integration tests. Pick a feature and write one!</p></li>
|
|
<li><p>Take a look at the <a href="http://bugs.joindiaspora.com">issue tracker</a> and pick a bug.
|
|
Write a spec for it, so it's easy for another developer to fix it.</p></li>
|
|
</ul>
|
|
|
|
|
|
<p>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.</p>
|
|
|
|
<p>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.</p>
|
|
|
|
<p>Please do not rebase our tree into yours.
|
|
See <a href="http://www.mail-archive.com/dri-devel@lists.sourceforge.net/msg39091.html">here</a>
|
|
for when to rebase.</p>
|
|
|
|
<p>We need you to fill out a
|
|
<a href="https://spreadsheets.google.com/a/joindiaspora.com/spreadsheet/viewform?formkey=dFdRTnY0TGtfaklKQXZNUndsMlJ2eGc6MQ">contributor agreement form</a>
|
|
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
|
|
<a href="https://spreadsheets.google.com/a/joindiaspora.com/spreadsheet/viewform?formkey=dFdRTnY0TGtfaklKQXZNUndsMlJ2eGc6MQ">here</a>.</p>
|
|
|
|
<h2>Resources</h2>
|
|
|
|
<p>Here is our <a href="http://bugs.joindiaspora.com">bug tracker</a> and our
|
|
<a href="https://github.com/diaspora/diaspora/wiki/Roadmap">roadmap</a>. Also, you can
|
|
find see what the core team is up to <a href="http://www.pivotaltracker.com/projects/61641">here</a>.</p>
|
|
|
|
<p>Ongoing discussion:</p>
|
|
|
|
<ul>
|
|
<li><a href="http://groups.google.com/group/diaspora-dev">Diaspora Developer Google Group</a></li>
|
|
<li><a href="http://groups.google.com/group/diaspora-discuss">Diaspora Discussion Google Group</a></li>
|
|
<li><a href="http://diaspora.shapado.com/">Diaspora Q&A site</a></li>
|
|
<li><a href="http://getsatisfaction.com/diaspora/">Diasproa on Get Satisfaction</a></li>
|
|
<li><a href="irc://irc.freenode.net/#diaspora">#diaspora IRC channel</a>
|
|
(<a href="http://webchat.freenode.net?channels=diaspora">join via the web client</a>)</li>
|
|
<li><a href="irc://irc.freenode.net/#diaspora-dev">#diaspora-dev IRC channel</a>
|
|
(<a href="http://webchat.freenode.net?channels=diaspora-dev">join via the web client</a>)</li>
|
|
</ul>
|
|
|
|
|
|
<p>More general info and updates about the project can be found on
|
|
<a href="http://blog.joindiaspora.com">our blog</a>,
|
|
<a href="http://twitter.com/joindiaspora">and on Twitter</a>.
|
|
Also, be sure to join the official <a href="http://eepurl.com/Vebk">mailing list</a>.</p>
|
|
|
|
<p>If you wish to contact us privately about any exploits in Diaspora you may
|
|
find, you can email
|
|
<a href="mailto:exploits@joindiaspora.com">exploits@joindiaspora.com</a>, <a href="http://pgp.mit.edu:11371/pks/lookup?op=vindex&search=0xCC6CAED977485064">corresponding public key (keyID: 77485064)</a>.</p></div></div>
|
|
|
|
<div id="footer">
|
|
Generated on Mon Jun 13 16:11:15 2011 by
|
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
0.7.1 (ruby-1.8.7).
|
|
</div>
|
|
|
|
</body>
|
|
</html> |