From: Tomas Sedovic <[email protected]>

Add missing dependencies (gems authlogic and rack-accept-media-types).

Fix typos, small updates.
---
 README.txt |   47 +++++++++++++++++++++++++----------------------
 1 files changed, 25 insertions(+), 22 deletions(-)

diff --git a/README.txt b/README.txt
index 1c61496..c126498 100644
--- a/README.txt
+++ b/README.txt
@@ -1,13 +1,15 @@
 Getting the sources
 -------------------
-The Deltacloud projects consists of two parts: **Core** and **Aggregator**. 
Core
-gives you the API and drivers to various cloud providers. Aggregator (formerly
-known as Portal) is a web frontend to the API.
+The Deltacloud project consists of two parts: **Core** and **Aggregator**. Core
+gives you the API and drivers to various cloud providers. It also provides a
+small client to the API so that you can see it in action.
+
+Aggregator (formerly known as Portal) is a web frontend to the API.
 
 In addition, there is the **docs** repository that contains the project
 documentation and the sources of the <http://deltacloud.org> website.
 
-You can browse the code repositories on the web:
+You can browse the repositories on the web:
 
 * [core](http://git.fedorahosted.org/git/?p=deltacloud/core.git;a=summary)
 * 
[aggregator](http://git.fedorahosted.org/git/?p=deltacloud/portal.git;a=shortlog;h=refs/heads/next)
@@ -16,15 +18,13 @@ You can browse the code repositories on the web:
 or download them to your computer:
 
     $ git clone git://git.fedorahosted.org/git/deltacloud/core.git/
-    $ git clone git://git.fedorahosted.org/git/deltacloud/portal.git/
-    $ git clone git://git.fedorahosted.org/git/deltacloud/docs.git/
+    $ git clone --branch next 
git://git.fedorahosted.org/git/deltacloud/portal.git/
+    $ git clone --branch next 
git://git.fedorahosted.org/git/deltacloud/docs.git/
 
-The development of the **docs** and **portal** takes place on the `next` 
branch:
+Note that the development of the **docs** and **portal** takes place on the
+`next` branch, which contains the latest version of the code.
 
-    $ cd path/to/deltacloud/docs
-    $ git checkout next
-    $ cd ../portal
-    $ git checkout next
+To get the stable version, omit the `--branch next` part.
 
 
 Installing packages
@@ -37,8 +37,14 @@ packages may vary):
     rubygem-daemons
     rubygem-gettext_rails
     rubygem-sqlite3-ruby
-    rubygem-compass (this is not yet in Fedora, so you'll have to gem install)
-    rubygem-haml (this is not yet in Fedora, so you'll have to gem install)
+    rubygem-haml
+
+Some packages are not in Fedora yet and you have to install them using
+[rubygems](http://rubygems.org/):
+
+    gem install compass
+    gem install rack-accept-media-types
+    gem install authlogic
 
 If you want to develop using PostgreSQL database instead of the default SQLite,
 install these, too:
@@ -118,24 +124,23 @@ This will run the Deltacloud Core server on port 3001.
 
 Setting up the Aggregator
 -------------------------
-Now we need to setup the Aggregator (which includes the UI).
-As your user who will run the Aggregator:
-
+Now we need to setup the Aggregator. As your user who will run the Aggregator:
 
 ### With SQLite ###
 
     $ cd path/to/deltacloud/portal/src/config
     $ cp database.sqlite database.yml
 
-**Note:** you can edit the "database.yml" file to change the location of the
-*.sqlite3 database files.
+**Note:** you can update the paths in the "database.yml" file to change the
+location of the *.sqlite3 database files.
 
     $ rake db:create:all
     $ rake db:migrate
     $ cd <wherever you put it>/db
 
 You should see the "development.sqlite3" file there. Make sure it is owned by
-the user who will run the Aggregator.
+the user who will run the Aggregator. The directory where the database files
+are stored must be also writable by this user.
 
 ### With PostgreSQL ###
 
@@ -152,12 +157,10 @@ You can now run the UI:
 
     $ ./script/server
 
-Which will start up the Aggregator UI on port 3000.
+Which will start up the Aggregator on port 3000.
 
 
 Checking out the UI
 -------------------
 Now that you have all of the components running, you should be able to point
 your web browser at <http://localhost:3000> and see the Aggregator page.
-
-**Happy hacking!**
-- 
1.6.6.1

_______________________________________________
deltacloud-devel mailing list
[email protected]
https://fedorahosted.org/mailman/listinfo/deltacloud-devel

Reply via email to