Skip to content
This repository has been archived by the owner on Oct 1, 2021. It is now read-only.

Commit

Permalink
Update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
dmexe committed Mar 6, 2009
1 parent 6c4ecfd commit fa39ccf
Showing 1 changed file with 76 additions and 9 deletions.
85 changes: 76 additions & 9 deletions README
@@ -1,13 +1,80 @@
Basic steps to setup:
It is the minor mode for editing Ruby On Rails code with Emacs. This
minor mode makes your work much easier and user friendly.

1. Setup `load-path':
(setq load-path (cons (expand-file-name "~/.emacs.d/rails-reloaded") load-path))

2. Put in your .emacs file:
(require 'rails-autoload)
== Requirements

3. To bytecompile after emacs restarted, type:
[M-x] rails/bytecompile
The emacs-rails-reloaded is requiring a 22.x or 23 (CVS) version of
Emacs, and can’t be running on old versions (less 22.0). To install
Emacs:

4. Optional: run unit tests for rails-reloaded:
[M-x] rails/selftest
* For UNIX: use your package manager (typically name of package emacs,
emacs-cvs or emacs22) or compile it from source.

* For OSX: use the "Aquameacs":http://aquamacs.org or nightly builds
of "CVS version with Cocoa":http://atomized.org/wp-content/cocoa-emacs-nightly/
or install using macports (name of package: emacs or emacs-app)

* For Windows: download and install "EmacsW32":http://ourcomments.org/Emacs/EmacsW32.html


== Instalation

Download last release from "github project page":http://github.com/dima-exe/emacs-rails-reloaded/downloads
and unpack it to directory containing libraries of Emacs, by default it’s
$HOME/.emacs.d/

After that add bellow code in your the .emacs file:

(setq load-path (cons (expand-file-name "~/.emacs.d/rails-reloaded") load-path))
(require 'rails-autoload)

Next bytecompile, press [M-x] and type rails/bytecompile.


== First Acquaintance

Go to directory with your rails application and open any file in Emacs:

cd $HOME/project/simple_rails_application
emacs app/controllers/application.rb

There must be “RoR” sign in the list of active minor-modes in status
bar. Thi means, that emacs-rails is enabled and ready to help you in
your not so easy work.

Almoust all actions are in the “RoR” menu. You can check it
out and try some of them. Don’t forget, that menu will help you only
first time. After that you better use hot keys for effective work, you
can find them in the brackets.


== Features

* Integration with script/generate, script/destroy and rake, press
[C-c '] or [C-c ;] and type 'rake', 'gen', 'des' to display
available tasks.

* Navigation around rails files, press [C-c '] or [C-c ;] to display
available files.

* Support test frameworks Test::Unit and RSpec.

* Management of WEBrick/Mongrel/Thing

* Per project configuration, you can setup the default port for server,
the environment or etc.

* Apidock.com integration, press [C-c '] or [C-c ;] and type who you
wish find.

* Textmate like snippets.


== Links

For bugs, patches and other requests:
http://dima.lighthouseapp.com/projects/1882-emacs-rails

Google group about rails development on Emacs:
http://groups.google.com/group/emacs-on-rails

0 comments on commit fa39ccf

Please sign in to comment.