updated the README a bit

This commit is contained in:
Bozhidar Batsov 2012-02-24 15:22:39 +02:00
parent f6768ef17d
commit ce3cb64147

View file

@ -17,17 +17,9 @@ is not yet officially released it's a rock solid piece of software
more than suitable for everyday work. There is no good excuse not to more than suitable for everyday work. There is no good excuse not to
use Emacs 24! use Emacs 24!
Emacs Prelude is not the only reusable Emacs config out there - the
Emacs Starter Kit is fairly popular and there is the Emacs Dev Kit
that I used to maintain. I've decided to abandon the Emacs Dev Kit for
the Emacs Prelude for two reasons - the unfortunate choice a name (too
similar to Emacs Starter Kit) and the totally new philosophy I have in
store for the Prelude (easy to update, easy to personalize, easy to
extend, highly modular, highly comprehensible).
## Fast Forward ## Fast Forward
Assuming you're using an Unix-like OS (*BSD, GNU/Linux, OS X, Solaris, 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 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 can skip the whole manual and just type in your favorite shell the
following command: following command:
@ -59,7 +51,7 @@ The second easy way to obtain Emacs 24 is via
[homebrew](http://mxcl.github.com/homebrew/). Just type the following [homebrew](http://mxcl.github.com/homebrew/). Just type the following
incantation in your shell and you're done: incantation in your shell and you're done:
``` ```bash
$ brew install emacs --cocoa --use-git-head --HEAD $ brew install emacs --cocoa --use-git-head --HEAD
$ cp -r /usr/local/Cellar/emacs/HEAD/Emacs.app /Applications/ $ cp -r /usr/local/Cellar/emacs/HEAD/Emacs.app /Applications/
``` ```
@ -70,6 +62,15 @@ start Emacs in daemon mode (`emacs --daemon`), so that I could share a
single Emacs instance between several Emacs clients (`emacsclient single Emacs instance between several Emacs clients (`emacsclient
-c/t`). -c/t`).
Chances are good you have an older version of Emacs installed by
default with OS X. I suggest you to remove that older Emacs version to
avoid conflicts with the new one. Do this:
```bash
$ sudo rm /usr/bin/emacs
$ sudo rm -rf /usr/share/emacs
```
That's all folk! You may now proceed to the configuration section. That's all folk! You may now proceed to the configuration section.
### Linux ### Linux
@ -90,7 +91,13 @@ to the rescue.
Debian/Ubuntu users should look no further than the amazing Debian/Ubuntu users should look no further than the amazing
[emacs-snapshot APT repo](http://emacs.naquadah.org/). You'll find [emacs-snapshot APT repo](http://emacs.naquadah.org/). You'll find
installation instructions there for all the relevant Debian and Ubuntu installation instructions there for all the relevant Debian and Ubuntu
versions out there. High quality, highly recommended builds! versions out there. High quality, highly recommended builds! After
you've added the repo you can install Emacs 24 with the following
command:
```bash
$ sudo apt-get install emacs-snapshot
```
Gentoo users have even less to do, since Emacs 24 can be obtained via Gentoo users have even less to do, since Emacs 24 can be obtained via
the emacs-vcs package in portage, as noted in the official the emacs-vcs package in portage, as noted in the official
@ -183,10 +190,14 @@ The following list will be expanded greatly in the future.
You can install Emacs via the command line with either `curl` or You can install Emacs via the command line with either `curl` or
`wget`. Naturally `git` is also required. `wget`. Naturally `git` is also required.
#### Via Curl
If you're using `curl` type the following command: If you're using `curl` type the following command:
`curl -L https://github.com/bbatsov/emacs-prelude/raw/master/utils/installer.sh | sh` `curl -L https://github.com/bbatsov/emacs-prelude/raw/master/utils/installer.sh | sh`
#### Via Wget
If you're using `wget` type: If you're using `wget` type:
`wget --no-check-certificate https://github.com/bbatsov/emacs-prelude/raw/master/utils/installer.sh -O - | sh` `wget --no-check-certificate https://github.com/bbatsov/emacs-prelude/raw/master/utils/installer.sh -O - | sh`
@ -234,14 +245,25 @@ alias vi=emacsclient -t
The last two aliases are helpful if you're used to editing files from The last two aliases are helpful if you're used to editing files from
the command line using `vi(m)`. the command line using `vi(m)`.
## Getting to know Prelude
Certainly the best way to understand how Prelude enhances the default
Emacs experience is to peruse Prelude's source code (which is
obviously written in Emacs Lisp). If you're intimidated by the source
- do not despair. Prelude includes a `prelude-mode` minor Emacs mode
which collects some of the additional functionality added by
Prelude. It also adds an additional keymap that binds many of those
extensions to keybindings.
## Color Themes ## Color Themes
Emacs 24 ships with a new theming facility that effectively renders Emacs 24 ships with a new theming facility that effectively renders
the old color-theme package obsolete. Emacs 24 provides a dozen of the old color-theme package obsolete. Emacs 24 provides a dozen of
built-in themes you can use out-of-the-box by invoking the `M-x built-in themes you can use out-of-the-box by invoking the `M-x
load-theme` command. Emacs Prelude adds two more popular themes to the load-theme` command. Emacs Prelude adds two more popular themes to the
mix - zenburn and solarized (I'm the maintainer of the Emacs ports mix - [Zenburn](https://github.com/bbatsov/zenburn-emacs) and
included). [Solarized](https://github.com/bbatsov/solarized-emacs) (I'm the
maintainer of the Emacs ports included).
Zenburn is the default color theme in Prelude, but you can change it Zenburn is the default color theme in Prelude, but you can change it
at your discretion. Why Zenburn? I (and lots of hackers around the at your discretion. Why Zenburn? I (and lots of hackers around the
@ -270,8 +292,9 @@ more) the proper way to do so would be to create Emacs Lisp files
under the **personal** directory in `prelude-dir`. They will be loaded under the **personal** directory in `prelude-dir`. They will be loaded
automatically be Prelude on startup. automatically be Prelude on startup.
Avoid modifying the Prelude config itself - this will make it hard for Avoid modifying the Prelude config itself (unless you're not
you to receive automatic updates in the future. intimidated to maintain a personal fork on GitHub)- this will make it
hard for you to receive automatic updates in the future.
## Caveats & Pitfalls ## Caveats & Pitfalls
@ -296,8 +319,8 @@ personal Emacs customization to enable them permanently.
### Windows compatibility ### Windows compatibility
While everything in Prelude should work fine in Windows I test it only While everything in Prelude should work fine in Windows, I test it only
with Linux & OSX so there are Windows related problems from time to with Linux & OSX, so there are Windows related problems from time to
time. This situation will probably improve over time. time. This situation will probably improve over time.
## Known issues ## Known issues
@ -318,5 +341,5 @@ I'd like to include a nice variety of Emacs 24 themes into Prelude -
so if you've developed (or simply found) one - give me a shout and so if you've developed (or simply found) one - give me a shout and
I'll take a look at it. I'll take a look at it.
Cheers, Cheers,<br>
Bozhidar Bozhidar