Moved to Emacs 24 and Emacs Starter Kit V2
Changes from Emacs Starter Kit
This modifications firstly targeting Ruby users and some modifications like "auto-complete" usefull for all users. You can add not included usefull packages like "rinari" for Ruby on Rails through ELPA.
- added "Rakefile" changed install method (look Installation)
- latest compiled rsense added
- rdebug added from
- auto-complete added as submodule
- ecb added as submodule
- yasnippet added as submodule (no need to install from ELPA)
- color-theme and themes removed from "elisp-to-submit" and added as submodule
- css-mode and yaml-mode removed from automatic install
- menu-bar-mode enabled
Features added to Emacs Starter Kit mostly united under two files starter-kit-m2ym.el and starter-kit-selman.el. You can look the features that is added but not activated in custom.el.sample file.
- Emacs >= 23.2 for ecb if you have lower version you can install "cedet" or don't activate "ecb"
- Java runtime Sun or Openjdk for rsense if you don't want to install disable rsense
- ruby-debug or ruby-debug19 gem (gem install ruby-debug19) for rdebug if you don't want to install disable rdebug
- git gem (sudo gem install git) for installation and updating if you don't want to use install from static package download page
Choose one of the installation methods:
- Download from download page
- tar zxvf esk-selman-x-x-x.tar.gz
- cd esk-selman-x-x-x
- rake install
- git clone git://github.com/selman/emacs-starter-kit.git
- cd emacs-starter-kit
- git submodule update --init
- rake install
- git clone firstname.lastname@example.org:YOURUSER/emacs-starter-kit.git
- cd emacs-start-kit
- git submodule update --init
- rake install
before "rake install" backup your ".emacs.d" folder
if you installed as 2. or 3. you can update with "rake update". if you installed as 3. you can push your changes with "rake merge" then "rake push" (run "rake -T" for other rake options). If you want to save your branch to github use "git push all" you must add your personel files to ".gitignore".
"git submodule update --init" must be run manualy or "rake install" giving errors but after first run "git submodule update --init" working from "Rakefile".
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.
Last solution for strange problems you can use "rake clobber" that will remove non git files and bytecompiled lisp files. Backup your personal files like "custom.el"
Note that having a ~/.emacs file might override the starter kit loading, so if you've having trouble loading it, make sure that file is not present.
Note on Patches/Pull Requests
- Fork the project.
- Make your feature addition or bug fix.
- Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
- Send me a pull request. Bonus points for topic branches.
Emacs Starter Kit
The Starter Kit should provide a saner set of defaults than you get normally with Emacs. It was originally intended for beginners, but it should provide a reasonable working environment for anyone using Emacs for dynamic languages. It also bundles a number of useful libraries that are not distributed with Emacs for various reasons.
The latest version is at http://github.com/technomancy/emacs-starter-kit/
This version of the Starter Kit acts as a set of config files you drop into your home directory. Version 2 (the v2 branch) is a set of packages you can pull in using package.el instead now that it's been included in Emacs.
This won't teach you Emacs, but it'll make it easier to get comfortable. To access the tutorial, press control-h followed by t.
The init.el file is where everything begins. It's the first file to get loaded. The starter-kit-* files provide what I consider to be better defaults, both for different programming languages and for built-in Emacs features like bindings or registers.
Directories under the "src" directory will be added the load-path automatic. if you added any folder or submodule here you don't need to define load-path.
Files that are pending submission to ELPA are bundled with the starter kit under the directory elpa-to-submit/. The understanding is that these are bundled just because nobody's gotten around to turning them into packages, and the bundling of them is temporary. For these libraries, autoloads will be generated and kept in the loaddefs.el file. This allows them to be loaded on demand rather than at startup.
There are also a few files that are meant for code that doesn't belong in the Starter Kit. First, the user-specific-config file is the file named after your user with the extension ".el". In addition, if a directory named after your user exists, it will be added to the load-path, and any elisp files in it will be loaded. Finally, the Starter Kit will look for a file named after the current hostname ending in ".el" which will allow host-specific configuration. This is where you should put code that you don't think would be useful to everyone. That will allow you to merge with newer versions of the starter-kit without conflicts.
Libraries from Marmalade installed via package.el are preferred when available since dependencies are handled automatically, and the burden to update them is removed from the user.
There's no vendor/ directory in the starter kit because if an external library is useful enough to be bundled with the starter kit, it should be useful enough to submit to Marmalade so that everyone can use it, not just users of the starter kit.
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, and breakage is common.
Please see the note re: "Future" above; active development is only happening on the "v2" branch.
If you know your way around Emacs, please try out the starter kit as a replacement for your regular dotfiles for a while. If there's anything you just can't live without, add it or let me know so I can add it. Take a look at what happens in init.el to get started.
Also: Helping submit new libraries to Marmalade is the easiest way to help out. This involves ensuring the library's dependencies are all already packaged and then adding the appropriate package headers and autoload comments. It's best to contact the package maintainer to ask them if they mind having their software distributed on Marmalade. It's also ideal to push your autoload/header changes back upstream.
Files are licensed under the same license as Emacs unless otherwise specified. See the file COPYING for details.