selman/my_emacs_for_rails

Emacs init file and plugins to enhance Ruby on Rails development experience

it's the last commit send here please use http://github.com/selman/emacs-starter-kit instead of this.

REQUIREMENTS
------------

Emacs >= 23.2
ruby & rake for intall and update
ruby-debug for rdebug emacs mode (gem install ruby-debug or gem install ruby-debug19)
rcodetools for multiple tools http://eigenclass.org/hiki.rb?rcodetools (gem install rcodetools)
spidermonkey >= 1.7.0 for flymake-javascript (http://ftp.mozilla.org/pub/mozilla.org/js/ or from package management)
JRE >= 1.5.0 for rsense completions SunJDK and OpenJDK are supported
autotest for autotest mod
autotest-rails for autotest if use for rails


DESCRIPTION
-----------

Emacs init file and plugins to enhance Ruby on Rails development experience.

Provides the following plugins:

auto-complete     (submodule => http://github.com/emacsmirror/auto-complete.git)
autotest          (http://www.emacswiki.org/emacs/RyanDavis)
color-theme
ecb               (submodule => http://github.com/emacsmirror/ecb.git)
flymake-ruby
flymake-javascript
rcodetools        (http://eigenclass.org/hiki.rb?rcodetools)
rdebug		  (copied => http://github.com/mark-moseley/ruby-debug)
redo+             (submodule => http://github.com/emacsmirror/redo-plus.git)
rinari            (http://rinari.rubyforge.org/)
rsense            (copied => http://cx4a.org/pub/rsense/rsense-0.3.tar.bz2)
ruby-block        (submodule => http://github.com/emacsmirror/ruby-block.git)
ruby-mode         (copied => svn co http://svn.ruby-lang.org/repos/ruby/trunk/misc)
textmate          (submodule => http://github.com/defunkt/textmate.el.git)
yaml-mode 	  (submodule => http://github.com/emacsmirror/yaml-mode.git)
yasnippet 	  (submodule => http://github.com/emacsmirror/ecb.git)
yasnippets-rails  (submodule => http://github.com/eschulte/yasnippets-rails.git)
yasnippets-rspec  (submodule => http://github.com/emacsmirror/yasnippets-rspec.git)


INSTALLATION
------------

after

git clone git://github.com/selman/my_emacs_for_rails.git

you have lots of choises

1. use bundled rake file for install and update (default behavior updates)

   to install and update:

   rake install

   to update:

   rake

2. link to directory

   ln -s path/to/my_emacs_for_rails ~/.emacs.d
   cd ~/.emacs.d
   git submodule update --init
   cp init.el.example init.el

3. Copy all the files to ~/.emacs.d directory and run

   cd ~/.emacs.d
   git submodule update --init
   cp init.el.example init.el


FONT
----

In the init.el file you have the following config font line

;; (setq default-frame-alist '((font . "inconsolata")))

Comment out this if you want to try inconsolata font, you must have this font installed on your system


USAGE
-----

Try some autocompletion under ruby-mode with crtl+i and ctrl+o
TODO complete ...


TODO
----

- Fix problems with certain key combinations. Sometimes Emacs debugger appears and its a bit annoying.
- Problems between autocompletion and tabkey2-mode when editing .html.erb files the suggestions doesn't work well

Please if you find a bug or something report me. Contributions and suggestions are welcome :)


CONTACT
-------

You can contact me: santiago@wyeworks.com
Follow us in our blog: http://blog.wyeworks.com
Repo: git://github.com/spastorino/my_emacs_for_rails.git