From ba9b0fdc2f4e30e67667d68e5ddf813f1bf60c36 Mon Sep 17 00:00:00 2001 From: Maxwell Salzberg Date: Mon, 7 May 2012 08:19:41 -0700 Subject: [PATCH] update readme to be slightly more clear about prereqs --- README.md | 29 ++++++++++++++++++----------- 1 file changed, 18 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index e3921568f..60799e688 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -## Welcome to the Diaspora Project! +Diaspora* Diaspora is a privacy-aware, personally-controlled, do-it-all open source social network. Check out our [project site](http://diasporaproject.org). @@ -12,19 +12,15 @@ If you want to do something big, reach out on IRC or the mailing list first, so With Diaspora you can: -- Run and host your own pod and have control over your own social experience. -- Own your own data. -- Make friends across other pods seamlessly. +- Make cool stuff +- Share it across the web +- Own your own data -Documentation is available on our [wiki](https://github.com/diaspora/diaspora/wiki) - -[Pull Request Guidelines](https://github.com/diaspora/diaspora/wiki/Pull-Request-Guidelines) - -Before submitting code, feel free to sign our [Contributor License Agreement](https://github.com/diaspora/diaspora/wiki/New-CLA--12-13-10) [Sign Here](https://spreadsheets.google.com/a/joindiaspora.com/spreadsheet/viewform?formkey=dFdRTnY0TGtfaklKQXZNUndsMlJ2eGc6MQ) ## Quick Start: -Here's how you can get a development environment up and running. You can check out system-specific guides [here](https://github.com/diaspora/diaspora/wiki/Installation-Guides). +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.com/installing-rails-3-1.html). ### Step 1: Download the script ``` @@ -46,7 +42,18 @@ then visit 'http://localhost:3000' in your browser. rake ``` -## Resources: +## Want a production setup? Having trouble with install script? Want to install D* the slow way? + Look to more specific install guides [here](https://github.com/diaspora/diaspora/wiki/Installation-Guides). + +## Contributing + +Documentation is available on our [wiki](https://github.com/diaspora/diaspora/wiki) + +[Pull Request Guidelines](https://github.com/diaspora/diaspora/wiki/Pull-Request-Guidelines) + +Before submitting code, please sign our [Contributor License Agreement](https://github.com/diaspora/diaspora/wiki/New-CLA--12-13-10) [Sign Here](https://spreadsheets.google.com/a/joindiaspora.com/spreadsheet/viewform?formkey=dFdRTnY0TGtfaklKQXZNUndsMlJ2eGc6MQ) + +## More Resources: - [Wiki](https://github.com/diaspora/diaspora/wiki) - [Podmin Resources](https://github.com/diaspora/diaspora/wiki/Podmin-Resources)