[PATCH conductor 1/1] Add README.md, intended to help developers get up and running quickly Removed README.creole so there is only one README.

Crag Wolfe cwolfe at redhat.com
Thu Jul 26 18:45:07 UTC 2012


---
 README.creole |   18 -------------
 README.md     |   79 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 79 insertions(+), 18 deletions(-)
 delete mode 100644 README.creole
 create mode 100644 README.md

diff --git a/README.creole b/README.creole
deleted file mode 100644
index 8c60c96..0000000
--- a/README.creole
+++ /dev/null
@@ -1,18 +0,0 @@
-= Aeolus Conductor =
-Aeolus Conductor is the web front-end to the [[https://www.aeolusproject.org/|Aeolus Project]], a software suite which aims to free users from cloud lock-in by providing a single, consistent set of tools to build and manage organized groups of virtual machines across clouds.
-
-== Installation ==
-Conductor has a number of dependencies. They are best outlined [[https://www.aeolusproject.org/get_it.html|here]] for now, which includes instructions for setting up and using our [[http://repos.fedorapeople.org/repos/aeolus/conductor/|yum repos]].
-
-== Developers ==
-Developers may find the [[https://www.aeolusproject.org/developers.html|Documentation for Developers]] page helpful.
-
-== Documentation ==
-* [[https://www.aeolusproject.org/about.html|Project Overview]], and a [[https://www.aeolusproject.org/projects.html|Project List]] with explanations.
-* [[https://www.aeolusproject.org/redmine/projects/aeolus/wiki/|Aeolus Project wiki]] (which could use a little cleanup)
-* [[https://www.aeolusproject.org/redmine/rb/master_backlogs/aeolus|Sprint backlog]]
-* [[https://www.aeolusproject.org/use_it.html|Using Aeolus Conductor]]
-
-== Contact ==
-Team members can be found in #aeolus on [[http://freenode.net/using_the_network.shtml|Freenode]]. We also make heavy use of the [[https://fedorahosted.org/mailman/listinfo/aeolus-devel|aeolus-devel@lists.fedorahosted.org]] mailing list. (You may also find the [[https://fedorahosted.org/pipermail/aeolus-devel/|aeolus-devel list archives]] helpful.) Don't be shy!
-
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0f3d8e6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,79 @@
+Aeolus Conductor
+================
+
+About
+-----
+Aeolus Conductor is a Ruby-based web application for cloud management.  It
+is one component of the [Aeolus Project](http://www.aeolusproject.org/).
+For a chart of how Conductor fits with the other components, see:
+[Aeolus Components](https://www.aeolusproject.org/redmine/projects/aeolus/wiki/Aeolus_Components) 
+
+Just Want To Try It Out?
+------------------------
+
+If you just want to try it out, start here:
+[Get It](https://www.aeolusproject.org/get_it.html)
+
+Otherwise, if you are a developer who wants to set up a development
+environment using the latest upstream code, this document is for you.
+
+Setting Up a Development Environment Using Bundler
+--------------------------------------------------
+
+All ruby gems that our project relies on are installed locally in a
+sandbox via bundler (gem and bundler must already be
+installed).  Of course, if other system-wide gems are installed that
+is fine too-- "bundle install" will pull in the version-specific
+dependencies it needs locally.
+
+### System Prerequisites ###
+
+There are a few things that need to be done as root or a sudo-enabled
+user before we check out the Conductor repository and fire up the
+development server.
+
+We rely on the system to provide some development libraries, ruby,
+gem, bundler and a database.  Specifically for RHEL 6 or Fedora Core
+16 or 17, we can grab these dependencies with:
+
+  yum install -y postgresql-server postgresql postgresql-devel ruby
+    ruby-devel ruby-rdoc git libxml2 libxml2-devel libxslt
+    libxslt-devel gcc gcc-c++
+
+  ^^assumes using postgres as our back-end database, but we could
+    just as well use sqlite or mysql.
+
+This set of requirements is not unusual and should look familiar to
+the experienced Ruby developer.  Of course, installing these libraries
+for another flavor of OS should also be relatively straightforward.
+
+As previously mentioned, gem and bundler also should be available on
+your system but no other system-wide gems are necessary.
+
+If you happen to be running RHEL6 or Fedora 16/17, you can download
+the script conductor-dev-root-prep.sh from
+https://gist.github.com/3178181 which installs the needed system
+dependencies and sets up postgres.
+
+Otherwise, you will need to adapt the steps in the script for your
+particular OS.
+
+### Setting Up a Development Workspace ###
+
+With the above prerequisites met, setting up a development environment
+is as easy as cloning the repository, bundle-installing the needed
+gems locally, and running a few rake commands.  See the OS-agnostic
+script conductor-dev-setup.sh from https://gist.github.com/3178181
+which does just that.  This script should *not* be run as root, rather
+as the non-privileged user you are going to do development with.
+
+Happy coding!
+
+Contact
+-------
+
+IRC: Team members can be found in #aeolus on [Freenode](http://freenode.net/using_the_network.shtml)
+
+Mailing List:  We also make heavy use of the mailing list
+[aeolus-devel at lists.fedorahosted.org](https://fedorahosted.org/mailman/listinfo/aeolus-devel).
+You may also find the [aeolus-devel list archives](https://fedorahosted.org/pipermail/aeolus-devel/) helpful.
-- 
1.7.1




More information about the aeolus-devel mailing list