diff options
author | Jonne Haß <me@mrzyx.de> | 2013-08-03 01:53:37 +0400 |
---|---|---|
committer | Jonne Haß <me@mrzyx.de> | 2013-08-03 21:32:13 +0400 |
commit | 38d3a342d09c2fa5f5283fcb9058e1e8cd04d981 (patch) | |
tree | 84460654db94bf2ce993d738f46c93078f4f5235 /README.md | |
parent | 2e9de37594fa677fc8caa0941d67943bbeef0050 (diff) |
rewrite readme [ci skip]
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 69 |
1 files changed, 23 insertions, 46 deletions
@@ -1,60 +1,37 @@ -Diaspora* +# diaspora* +### a privacy aware, distributed, open source social network -Diaspora is a privacy-aware, personally-controlled, do-it-all open source social network. Check out our [project site](http://diasporafoundation.org). +**master:** [![Build Status master](https://secure.travis-ci.org/diaspora/diaspora.png?branch=master)](http://travis-ci.org/diaspora/diaspora) +**develop:** [![Build Status develop](https://secure.travis-ci.org/diaspora/diaspora.png?branch=develop)](http://travis-ci.org/diaspora/diaspora) | +[![Dependency Status](https://gemnasium.com/diaspora/diaspora.png?travis)](https://gemnasium.com/diaspora/diaspora) +[![Code Climate](https://codeclimate.com/github/diaspora/diaspora.png)](https://codeclimate.com/github/diaspora/diaspora) -* **master:** [![Build Status master](https://secure.travis-ci.org/diaspora/diaspora.png?branch=master)](http://travis-ci.org/diaspora/diaspora) -* **develop:** [![Build Status develop](https://secure.travis-ci.org/diaspora/diaspora.png?branch=develop)](http://travis-ci.org/diaspora/diaspora) -* [![Dependency Status](https://gemnasium.com/diaspora/diaspora.png?travis)](https://gemnasium.com/diaspora/diaspora) -* [![Code Climate](https://codeclimate.com/github/diaspora/diaspora.png)](https://codeclimate.com/github/diaspora/diaspora) +[Project site](https://diasporafoundation.org) | +[Wiki](https://wiki.diasporafoundation.org) | +[Bugtracker](http://github.com/diaspora/diaspora/issues) | +[Discussions](https://www.loomio.org/groups/194) | +[Mailing lists](https://wiki.diasporafoundation.org/How_We_Communicate#Mailing_Lists) | +[License](/COPYRIGHT) | +[Authors](https://github.com/diaspora/diaspora/contributors) +## Installation -With Diaspora you can: -- Make cool stuff -- Share it across the web -- Own your own data +You don't have to install diaspora* to use the network. There are many servers connected to diaspora*s network which are open to anyone, and you can create an account on one of these servers. Have a look at our [tips for finding a home](https://wiki.diasporafoundation.org/Choosing_a_pod), or you can just go straight to the [list of open servers](http://podupti.me) to sign up. +Want to own your data and install diaspora*? Whether you just want to try it out, want to install it on your server or want to contribute and need a development setup, our [installation guides](https://wiki.diasporafoundation.org/Installation) will get you started! -## Quick Start: +## Questions? -Here's how you can get a **[development](http://guides.rubyonrails.org/getting_started.html)** environment up and running. This is where any new pod runner should start, as well as people -looking to contribute to D*. This script assumes you have [a basic Rails setup installed](http://railsapps.github.io/installing-rails.html). +Have a look at our FAQs [for users](https://wiki.diasporafoundation.org/FAQ_for_users), [for pod administrators](https://wiki.diasporafoundation.org/FAQ_for_pod_maintainers) or [for developers](https://wiki.diasporafoundation.org/FAQ_for_developers). -### Step 1: Run the script and follow the on screen instructions. -```bash - bash <(curl https://raw.github.com/diaspora/diaspora/master/script/install.sh) -``` +Still haven't found an answer? Talk to us! Read [how we communicate](https://wiki.diasporafoundation.org/How_we_communicate). We're here to answer all your questions. +## Contribute -### Step 2: Run the development server -```bash - rails s -``` +To keep diaspora* growing and improving we need all help we can get. Whether you can contribute [code](https://wiki.diasporafoundation.org/Getting_started_with_contributing), [ideas](https://wiki.diasporafoundation.org/How_we_communicate#Loomio), [translations](https://wiki.diasporafoundation.org/Contribute_translations), [bug reports](https://wiki.diasporafoundation.org/How_to_report_a_bug) or simply extend the community as a [helpful user](https://wiki.diasporafoundation.org/Welcoming_committee) or [pod administrator](https://wiki.diasporafoundation.org/Installation), your help is welcome! -then visit 'http://localhost:3000' in your browser. +## Security -### Step 3 (for developers): Run tests -```bash - rake -``` +Found a security issue? Please disclose it responsibly. We have a team of developers listening to [security@diasporafoundation.org](mailto:security@diasporafoundation.org). The PGP fingerprint is [AB0D AB02 0FC5 D398 03AB 3CE1 6F70 243F 27AD 886A](http://pgp.mit.edu:11371/pks/lookup?op=get&search=0x6F70243F27AD886A) -### Step 4 (for everyone): Party. - - -### Want a production setup? Having trouble with install script? Want to install D* the slow way? - Look to more specific install guides [here](http://wiki.diasporafoundation.org/Installation_guides). - -## Contributing -We love community contributions, and we work extra hard to make sure every code contribution is looked at and given feedback. -To help everyone involved, please review our [Pull Request Guidelines](http://wiki.diasporafoundation.org/Pull_Request_Guidelines) -to make sure all contributions are submitted smoothly. - -Documentation is available on our [wiki](http://wiki.diasporafoundation.org) - -## More Resources: - -- [Wiki](http://wiki.diasporafoundation.org) -- [Podmin Resources](http://wiki.diasporafoundation.org/Category:Podmin) -- [Contributing](http://wiki.diasporafoundation.org/Getting_Started_With_Contributing) -* [Mailing lists](http://wiki.diasporafoundation.org/How_We_Communicate#Mailing_Lists) -- [IRC](http://wiki.diasporafoundation.org/How_We_Communicate#IRC) |