Prelude is an enhanced Emacs 24 distribution that should make your experience with Emacs both more pleasant and more powerful.
Prelude is an Emacs distribution that aims to enhance the default Emacs experience. Prelude alters a lot of the default settings, bundles a plethora of additional packages and adds its own core library to the mix. The final product offers an easy to use Emacs configuration for Emacs newcomers and lots of additional power for Emacs power users.
Prelude is compatible ONLY with GNU Emacs 24.x. In general you're advised to always run Prelude with the latest Emacs - currently 24.3.
Table of Contents
You can now power up your Emacs, sit back and enjoy Prelude,
forgetting about the rest of this manual.
There are two environment variables you can use to control the source repository and the installation directory. To change the installation directory:
To change the source repository:
Note that the installer will back up any existing
Don't forget to adjust your
You'd do well to replace
The
from https://github.com/bbatsov/prelude
Prelude is an Emacs distribution that aims to enhance the default Emacs experience. Prelude alters a lot of the default settings, bundles a plethora of additional packages and adds its own core library to the mix. The final product offers an easy to use Emacs configuration for Emacs newcomers and lots of additional power for Emacs power users.
Prelude is compatible ONLY with GNU Emacs 24.x. In general you're advised to always run Prelude with the latest Emacs - currently 24.3.
Table of Contents
- Fast Forward
- Installing Emacs 24
- Installation
- Updating Prelude
- Enabling additional modules
- Running
- Getting to know Prelude
- Automatic package installation
- Caveats & Pitfalls
- Known issues
- Support
- Contributors
- Bugs & Improvements
Fast Forward
Assuming you're using an Unix-like OS (*BSD
, GNU/Linux
, OS X
, Solaris
,
etc), you already have Emacs 24 installed, as well as git
& curl
you
can skip the whole manual and just type in your favorite shell the
following command:curl -L http://git.io/epre | sh
There are two environment variables you can use to control the source repository and the installation directory. To change the installation directory:
export PRELUDE_INSTALL_DIR="$HOME/.emacs.d" && curl -L https://github.com/bbatsov/prelude/raw/master/utils/installer.sh | sh
export PRELUDE_URL="https://github.com/yourname/prelude.git" && curl -L https://github.com/bbatsov/prelude/raw/master/utils/installer.sh | sh
.emacs
file or
.emacs.d
since it will unpack Prelude's code in .emacs.d
. If
you're doing a manual install make sure you don't have a .emacs
file
or back up your existing .emacs.d
directory manually.Don't forget to adjust your
prelude-modules.el
file once the installation is done.
By default most of the modules that ship with Prelude are not loaded.Installing Emacs 24
Obviously to use the Emacs Prelude you have to install Emacs 24 first. Have a look at the WikEmacs articles on installing Emacs.Installation
Automated
You can install Emacs Prelude via the command line with eithercurl
or
wget
. Naturally git
is also required.Via Curl
If you're usingcurl
type the following command:curl -L https://github.com/bbatsov/prelude/raw/master/utils/installer.sh | sh
Via Wget
If you're usingwget
type:wget --no-check-certificate https://github.com/bbatsov/prelude/raw/master/utils/installer.sh -O - | sh
Manual
git clone git://github.com/bbatsov/prelude.git path/to/local/repo
ln -s path/to/local/repo ~/.emacs.d
cd ~/.emacs.d
~/.emacs.d
with the value of
user-emacs-directory
for your OS. You can check the value by doing
C-h v user-emacs-directory
inside Emacs.Updating Prelude
Manual update
The update procedure is fairly straightforward and consists of 3 steps:Update all bundled packages
Just run M-x package-list-packages RET U x.Update Prelude's code
cd path/to/prelude/installation
git pull
path/to/prelude/installation
is usually ~/.emacs.d
(at least
on Unix systems).Restart Prelude
It's generally a good idea to stop Emacs after you do the update. The next time Prelude starts it will install any new dependencies (if there are such).Automatic update
Simply run M-x prelude-update from Emacs itself and restart Emacs afterwards.Enabling additional modules
By default most of the modules that ship with Prelude are not loaded. For more information on the functionality provided by these modules visit the docs.from https://github.com/bbatsov/prelude