Skip to content

Commit

Permalink
Typos and doc tweaks.
Browse files Browse the repository at this point in the history
  • Loading branch information
thomasn committed Jun 30, 2009
1 parent d35d19c commit c287b79
Showing 1 changed file with 19 additions and 16 deletions.
35 changes: 19 additions & 16 deletions README.md
Expand Up @@ -13,7 +13,7 @@ Railfrog is a simple and straightforward Content Management System for publishin

The first thing you must know is that Railfrog comes in two flavours.

* First we have **Railfrog** as such: it is a *Ruby on Rails Engine* and you will find it at <http://github.com/railfrog/railfrog/tree/master>.
* First we have **Railfrog** itself: this is a *Ruby on Rails Engine* and you will find it at <http://github.com/railfrog/railfrog/tree/master>.

* Then we have the **Railfrog Content Management System** which is an application using the Railfrog engine to build a simple CMS. You can find it at <http://github.com/railfrog/railfrogcms/tree/master>.

Expand All @@ -29,23 +29,22 @@ Railfrog is built on top of Ruby on Rails, and runs anywhere you can get Ruby on

You need to have the following:

1. **Ruby interpreter**. We currently require Ruby version 1.8.6. Note that Ruby 1.8.7 is not currently supported. If you are on Mac OS/X or on Linux, you will most likely have Ruby available; otherwise you can get it from <http://www.ruby-lang.org>. If you are on Windows, the quickest way to get ruby is thrught the [Ruby one click installer](http://rubyforge.org/projects/rubyinstaller/).
2. **RubyGems**. See <http://www.rubygems.org>
3. **SQLite**, **MySQL** or **PostgreSQL**. There's a [long list of databases for use with Rails](http://api.rubyonrails.com/files/vendor/rails/activerecord/README.html), please let us know if you have problems.
4. **Git**. If you do not have git on your system, see "[Install Git](http://git-scm.com/download)".
Git will be used then clone the railfrogcms repository, and all required resources, including the appropriate version of Rails, are then installed automatically.
1. **Ruby interpreter**. We currently require Ruby version 1.8.6. Note that Ruby 1.8.7 is not currently supported. If you are on Mac OS/X or on Linux, you will most likely have Ruby available; otherwise you can get it from <http://www.ruby-lang.org>. If you are on Windows, the quickest way to get ruby is using the [Ruby one click installer](http://rubyforge.org/projects/rubyinstaller/).
2. **RubyGems**. Again, this may already be installed; on Windows it's included in the "one click installer". If you don't yet have it, see the [RubyGems manual](http://rubygems.org/read/chapter/3) for installation instructions.
3. **SQLite**, **MySQL** or **PostgreSQL**. There's also a [long list of other databases for use with Rails](http://api.rubyonrails.com/files/vendor/rails/activerecord/README.html) which we haven't tested, please let us know if you have problems with one of these.
4. **Git**. If you do not have git on your system, see "[Install Git](http://git-scm.com/download)". On Windows we recommend the msysGit "official full installer" package. Git will be used to clone the railfrogcms repository; all required resources, including the appropriate version of Rails, will then be installed automatically.

If you want to do more than just install the Railfrog CMS and publish a website, you should be familiar with Ruby on Rails. If you are not, then you might want to go through the [Getting Started with Rails](http://guides.rubyonrails.org/getting_started.html) guide.

Before you proceed with installation, you may want to make sure you are able to create and start a simple Ruby on Rails application. This will reassure you that you have all the required bits and pieces installed and running (the ruby interpreter, the database, the web server, etc.).
Before you proceed with installation, you may want to make sure you are able to create and start a simple Ruby on Rails application. This is not required, but will reassure you that you have all the required bits and pieces installed and running (the ruby interpreter, the database, the web server, etc.).

While you might have Ruby on Rails already installed on your system (or you installed it yourself following the above mentioned Getting Started guide), when you perform the following instructions to install the Railfrog CMS, you will get a specific version of Rails installed under the *vendor* directory. This is to ensure that Railfrog runs against the specific version of Rails that is needed (and that one might *not* be the same as the one that is already installed on your computer).

## Installation

Railfrog setup currently requires that you use a commandline "shell" (called Command Prompt, Terminal or Konsole on various platforms) - but even if you have not done this before, it's very straightforward.

**Note:** In the following instructions we are prefixing all the commands with "sudo", which is what you need to gain administrator privileges on linux and Mac. If you are on Windows, type the same commands at the "C:\>" prompt (Start | All Programs | Accessories | Command Prompt), but without the "sudo".
**Note:** In the following instructions we are prefixing all the commands with "sudo", which is what you need to gain administrator privileges on Linux and Mac. If you are on Windows, type the same commands at the "C:\>" prompt (Start | All Programs | Accessories | Command Prompt), but without the "sudo".

### Step 1. Ensure you Have the Right Gems

Expand All @@ -61,7 +60,7 @@ Note that capitalisation is important; it's RedCloth, not redcloth.

### Step 2. Ensure you Have the Right Version of Rake

At the time of writing, Raifrog requires Rails 2.0.5. As mentioned earlier, you will get that version of Rails when you clone the Railfrog CMS repository following these instructions. However, another dependency that is not resolved automatically is on the corresponding version of Rake. You must ensure you have the correct version of Rake available on your system (and then that you use it when migrating the database, as explained later). You can have multiple versions installed at the same time.
At the time of writing, Raifrog requires Rails 2.0.5. As mentioned earlier, you'll get that version of Rails when you clone the Railfrog CMS repository following these instructions. However, another dependency that is not resolved automatically is on the corresponding version of Rake. You must ensure you have the correct version of Rake available on your system (and then that you use it when migrating the database, as explained later). You can have multiple versions installed at the same time.

**DO THIS:**

Expand All @@ -77,23 +76,23 @@ Use git to download the RailfrogCMS files from the github repository. The files

**DO THIS:**

git clone git://github.com/railfrog/railfrogcms.gitk
git clone git://github.com/railfrog/railfrogcms.git

Now move into the *railfrogcms* directory:
Now change to the `railfrogcms` directory:

**DO THIS:**

cd railfrogcms

### Step 4. Fetch the Git Submodules

With this step you will fetch the correct version of Rails and any other vital components and install them into the `vendor` sudirectory of `railfrogcms`. Beware that this step might take a little while to download, since Rails is a large and sophisticated framework:
With this step you will fetch the correct version of Rails and any other required components and install them into the `vendor` sudirectory of `railfrogcms`. Beware that this step might take a little while to download, since Rails is a large and sophisticated framework:

**DO THIS:**

git submodule update --init

You will notice that after this step you will have a number of new directories under `vendor`. In addition to `rails`, notice that you now have `plugins/railfrog` there: this is the actual Railfrog engine. You'll get the latest version of the Railfrog engine that is tested to work with RailfrogCMS.
You will notice that after this step you will have a number of new directories under `vendor`. In addition to `vendor/rails`, notice that you now have `vendor/plugins/railfrog`: this is the actual Railfrog engine. You'll get the latest version of the Railfrog engine that is tested to work with RailfrogCMS.

### Step 5. Configure Your Database Connection

Expand All @@ -105,7 +104,7 @@ You will notice that after this step you will have a number of new directories u

### Step 6. Create the Database

Assuming that your database connection is configured properly, you can now creae the database by running the migrate script. It is at this point that you must ensure to use Rake version 0.7.3 that you previously installed in Step 2.
Assuming that your database connection is configured properly, you can now create the database by running the migrate script. Here you'll use Rake version 0.7.3, the version that you previously installed in Step 2.

**DO THIS:** (and, Yes!, you have to type those underscores...)

Expand All @@ -119,17 +118,21 @@ Start the Railfrog server:

script/server

Rails will output status messages as it starts up; any problems with your setup will usually result in error messages being displayed here.

Now open a browser at <http://localhost:3000/admin> and you should see the Railfrog administration interface.

**Note:** Opening http://localhost:3000/ will show a "404 Page Not Found" error, which is correct since you haven't configured a site yet. To configure the site you'll use the administration interface.

## Next Steps

See the [wiki docs](http://wiki.github.com/railfrog/railfrog) for instructions on setting up your new site.
See the [wiki docs](http://wiki.github.com/railfrog/railfrog) for instructions on setting up your new site. Once you have it working, you'll probably want to check the deployment documentation and deploy to a public server.

If it doesn't work for you, try asking for help on the [mailing list](http://groups.google.com/group/railfrog-dev)
or on the `#railfrog` irc channel on `irc.freenode.net`.


We hope you find it useful.
We hope you find it useful - if you do, please consider contributing ideas, suggestions -- or even code -- to help us achieve our goal:

**Design, Deploy and Maintain Websites -- with Joy!**

0 comments on commit c287b79

Please sign in to comment.