forked from diaspora/diaspora
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
23 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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:** [](http://travis-ci.org/diaspora/diaspora) | ||
**develop:** [](http://travis-ci.org/diaspora/diaspora) | | ||
[](https://gemnasium.com/diaspora/diaspora) | ||
[](https://codeclimate.com/github/diaspora/diaspora) | ||
|
||
* **master:** [](http://travis-ci.org/diaspora/diaspora) | ||
* **develop:** [](http://travis-ci.org/diaspora/diaspora) | ||
* [](https://gemnasium.com/diaspora/diaspora) | ||
* [](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 [[email protected]](mailto:[email protected]). 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) |