From: Tomas Sedovic <[email protected]>

* Remove the prompt sign from the commandline examples.
* Add missing dependencies for Sinatra and Thin rubygems.
* Mention 'amazon-ec2' gem requirement for Amazon driver.
* Remove `gem build` from core install in readme.
---
 README             |   57 ++++++++++++++++++++++++++-------------------------
 docs/drivers.mdown |    4 +++
 2 files changed, 33 insertions(+), 28 deletions(-)

diff --git a/README b/README
index ed94038..1fc707b 100644
--- a/README
+++ b/README
@@ -17,9 +17,9 @@ You can browse the repositories on the web:
 
 or download them to your computer:
 
-    $ git clone git://git.fedorahosted.org/git/deltacloud/core.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/
+    git clone git://git.fedorahosted.org/git/deltacloud/core.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/
 
 Note that the development of the **docs** and **portal** takes place on the
 `next` branch, which contains the latest version of the code.
@@ -38,6 +38,8 @@ packages may vary):
     rubygem-gettext_rails
     rubygem-sqlite3-ruby
     rubygem-haml
+    rubygem-sinatra
+    rubygem-thin
 
 Some packages are not in Fedora yet and you have to install them using
 [rubygems](http://rubygems.org/):
@@ -55,13 +57,13 @@ install these, too:
 
 You will also need **deltacloud-client** gem. You can either install the 
packaged version:
 
-    $ gem install deltacloud-client
+    sudo gem install deltacloud-client
 
 or build it yourself from the **core** repository:
 
-    $ cd core/client
-    $ gem build deltacloud-client.gemspec
-    $ gem install deltacloud-client-*.gem
+    cd core/client
+    gem build deltacloud-client.gemspec
+    sudo gem install deltacloud-client-<version>.gem
 
 
 Database
@@ -84,13 +86,13 @@ PostgreSQL database setup
 Once you have the proper packages installed you have to setup the
 postgresql database.  As root:
 
-    # /sbin/service postgresql initdb
-    # /sbin/service postgresql start
-    # su - postgres
-    $ psql
+    /sbin/service postgresql initdb
+    /sbin/service postgresql start
+    su - postgres
+    psql
     postgres=# CREATE USER dcloud WITH PASSWORD 'v23zj59an' CREATEDB;
     postgres=# \q
-    $ exit
+    exit
 
 Now you need to edit the pg_hba.conf file
 (`/var/lib/pgsql/data/pg_hba.conf` on Fedora 12):
@@ -120,14 +122,13 @@ The easiest way to solve the gem dependencies is to build 
the deltacloud-core
 gem:
 
     cd path/to/deltacloud/core/server
-    gem build deltacloud-core.gemspec
     rake package
     sudo gem install pkg/deltacloud-core-<version>.gem
 
 To start the server, run the `delacloudd` script:
 
-    $ cd path/to/deltacloud/core/server/bin
-    $ ./deltacloudd -i mock
+    cd path/to/deltacloud/core/server/bin
+    ./deltacloudd -i mock
 
 This will run the Deltacloud Core server on port 3001.
 
@@ -138,15 +139,15 @@ 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
+    cd path/to/deltacloud/portal/src/config
+    cp database.sqlite database.yml
 
 **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
+    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 directory where the database files
@@ -154,18 +155,18 @@ are stored must be also writable by this user.
 
 ### With PostgreSQL ###
 
-    $ cd path/to/deltacloud/portal/src
-    $ cp database.pg database.yml
-    $ rake db:create:all
-    $ rake db:migrate
-    $ rake db:test:prepare
+    cd path/to/deltacloud/portal/src
+    cp database.pg database.yml
+    rake db:create:all
+    rake db:migrate
+    rake db:test:prepare
 
 If all went well here, then the database should be ready for you
 to start up the Aggregator.
 
 You can now run the UI:
 
-    $ ./script/server
+    ./script/server
 
 Which will start up the Aggregator on port 3000.
 
@@ -181,5 +182,5 @@ We recommend setting up one user as an administrator of the 
site.
 
 This is how you turn an existing user into an admin:
 
-    $ cd path/to/deltacloud/portal/src
-    $ rake dc:site_admin[aggregator_username]
+    cd path/to/deltacloud/portal/src
+    rake dc:site_admin[aggregator_username]
diff --git a/docs/drivers.mdown b/docs/drivers.mdown
index 58a666e..9c4ce4f 100644
--- a/docs/drivers.mdown
+++ b/docs/drivers.mdown
@@ -32,6 +32,10 @@ pretty view of the objects the driver deals with.
 
 ### EC2 Driver
 
+For the Amazon EC2 you need to install the `amazon-ec2` Ruby gem:
+
+    sudo gem install amazon-ec2
+
 When using the driver for Amazon EC2, the credentials passed in
 response to the HTTP 401 authentication challenge should be your
 *access_key* and *secret_access_key*
-- 
1.6.6.1

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

Reply via email to