@@ -19,16 +19,19 @@ screencast](http://peepcode.com/products/meet-emacs) helpful. The ## Installation -1. Install Emacs (at least version 22) +1. Install GNU Emacs (at least version 22, 23 is preferred) Use your package manager if you have one. Otherwise, Mac users should get it [from Apple](http://www.apple.com/downloads/macosx/unix_open_source/carbonemacspackage.html). Windows users can get it [from GNU](http://ftp.gnu.org/gnu/emacs/windows/emacs-22.3-bin-i386.zip). -2. Move the directory containing this file to ~/.emacs.d [1] - (If you already have a directory at ~/.emacs.d move it out of the way and put this there instead.) +2. Move the directory containing this file to ~/.emacs.d + (If you already have a directory at ~/.emacs.d move it out of the + way and put this there instead.) 3. Launch Emacs! -If you are missing some autoloads after an update (should manifest -itself as "void function: foobar" errors) try M-x regen-autoloads. +If you find yourself missing some autoloads after an update (which +should manifest itself as "void function: foobar" errors) try M-x +regen-autoloads. After some updates an M-x recompile-init will be +necessary; this should be noted in the commit messages. If you want to keep your regular ~/.emacs.d in place and just launch a single instance using the starter kit, try the following invocation: @@ -86,6 +89,14 @@ packages. If you run into problems with such a package, try removing everything from inside the elpa/ directory and invoking M-x starter-kit-elpa-install in a fresh instance. +## Variants of Emacs + +The Starter Kit is designed to work with GNU Emacs version 22 or +greater. Using it with forks or other variants is not supported. It +probably won't work with XEmacs, though some have reported getting it +to work with Aquamacs. However, since Aquamacs is not portable, +it's difficult to test in it. + ## Contributing If you know your way around Emacs, please try out the starter kit as a README.markdown @@ -2,15 +2,11 @@ TODO: Submit the packages in starter-kit-elpa.el to ELPA. -Greg Newman is working on Python helpers. - -maybe include: -* should yasnippet be included in rinari? - to write/finish: * submit ruby fixes to flymake which-func-mode in ruby? Bug fixes: -get jabber.el to automatically disconnect when suspending/hibernating (via dbus) \ No newline at end of file +get jabber.el to automatically disconnect when suspending/hibernating (via dbus) +same with rcirc.el \ No newline at end of file TODO 5a2eff39015e5d10f9e7ab2a7cbfdb34a7586fd4 Phil Hagelberg technomancy@gmail.com http://github.com/technomancy/emacs-starter-kit/commit/5d72d8e65537c702cbdf9f9c5279af12f4a24ad8 5d72d8e65537c702cbdf9f9c5279af12f4a24ad8

2009-09-07T15:19:58-07:00

Update installation notes and mention Aquamacs is unsupported in the readme. 5b5eed9c6d414202b639e94c0224930f745aa9b7 Phil Hagelberg technomancy@gmail.com