rlbr
/
emacs_config_prelude
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

removed a lot of stuff and moved them to the project's page

custom
Bozhidar Batsov 14 years ago
parent
d7cc771c7d
commit
cc82212874
1 changed files with 3 additions and 339 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 342
      README.md

342
README.md
View File

@ -34,347 +34,11 @@ following command:
https://github.com/bbatsov/emacs-prelude/raw/master/utils/installer.sh https://github.com/bbatsov/emacs-prelude/raw/master/utils/installer.sh
| sh` | sh`
You can now power up your Emacs, sit back and enjoy Prelude,
forgetting about the rest of this manual.
You can now power up your Emacs, sit back and enjoy Prelude.
## Getting Emacs 24
## Would you like to know more?
Obviously to use the Emacs Prelude you have to install Emacs 24
first. Here's a few tips on doing so:
### OS X
Obtaining Emacs 24 on OS X is really simple. There are two popular
ways to do it. The first is to simply download a pretest (or a nightly
build) from [Emacs for OSX](http://emacsformacosx.com). My personal
recommendation would be to get the latest pretest from
[here](http://emacsformacosx.com/builds).
That was really easy, right?
The second easy way to obtain Emacs 24 is via
[homebrew](http://mxcl.github.com/homebrew/) (keep in mind though that
**snapshot builds are often buggy** to some extend - installing a pretest
is generally a better option). Just type the following
incantation in your shell and you're done:
```bash
$ brew install emacs --cocoa --use-git-head --HEAD
$ cp -r /usr/local/Cellar/emacs/HEAD/Emacs.app /Applications/
```
The second step is optional, but it's recommended if you like to start
Emacs from the launchpad or from Spotlight. Personally I prefer to
start Emacs in daemon mode (`emacs --daemon`), so that I could share a
single Emacs instance between several Emacs clients (`emacsclient
-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.
### Linux
Given that Linux is more or less the home os of Emacs it presents us
with the most installation options. Of course, we can build Emacs from
[source](https://github.com/emacsmirror/emacs) on every distribution
out there, but I rarely bother to do so. Using the distribution's
package manager is a better idea for many reasons - you don't need to
install a build chain and lots of dev libraries, you get updated
versions when they are released and you get automated dependency
manager, just to name a few.
That said, few distributions include in their primary repositories
builds of Emacs 24. Luckily there are some unofficial repos that come
to the rescue.
Debian users should look no further than the amazing
[emacs-snapshot APT repo](http://emacs.naquadah.org/). You'll find
installation instructions there for all the relevant Debian
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
```
Ubuntu users have easy access to Emacs 24 as well:
```bash
$ sudo apt-add-repository ppa:cassou/emacs
$ sudo apt-get install emacs-snapshot
```
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
[Emacs on Gentoo page](http://www.gentoo.org/proj/en/lisp/emacs/emacs.xml).
Unfortunately I wasn't able to find prebuilt Emacs 24 packages for any
of the RPM distros (Fedora, SUSE, Mandriva, etc). Since, I'm Debian
user I have to admit that I didn't look that far, but the source
installation is not particularly hard and is always an option.
### Windows
There are several ways to obtain precompiled Emacs 24 binaries if
you're a Windows users. The most popular are
[EmacsW32](http://ourcomments.org/cgi-bin/emacsw32-dl-latest.pl),
[Emacs for Windows](http://code.google.com/p/emacs-for-windows/) and
of course the official
[Emacs Windows builds](http://alpha.gnu.org/gnu/emacs/windows/). I've
,personally, never used any builds other than the official ones. The
unofficial builds usually include installers and various patches that
might be of use to some users.
Since I rarely use Windows I cannot give you any more advice on the
choice of a binary vendor.
## Enhanced programming experience
The following list will be expanded greatly in the future.
### Additional programming languages support
* [Clojure](https://github.com/technomancy/clojure-mode)
* [CoffeeScript](https://github.com/defunkt/coffee-mode)
* [Erlang](http://www.erlang.org/doc/apps/tools/erlang_mode_chapter.html)
* [Groovy](http://groovy.codehaus.org/Emacs+Groovy+Mode)
* [Haskell](http://www.haskell.org/haskellwiki/Haskell_mode_for_Emacs)
### Additional markup languages support
* Markdown
* Sass
* Haml
* Yaml
* LaTeX
### Enhanced configuration
* C
* Clojure
* CoffeeScript
* Common Lisp
* ERC
* JavaScript
* Python
* Ruby
* Scheme
* XML
## Enhanced productivity
* [Projectile](https://github.com/bbatsov/projectile)
* yasnippet
## Bundled packages
* auctex (LaTeX editing)
* clojure-mode
* coffee-mode
* deft (note taking)
* gist (snippet sharing on github.com)
* groovy-mode
* expand-region
* haml-mode
* haskell-mode
* magit (enhanced git integration)
* markdown-mode
* paredit
* projectile (project management mode)
* python.el (improved Python mode)
* sass-mode
* scss-mode
* yaml-mode
* yari (ri frontend)
* yasnippet
## Installation
### Automated
You can install Emacs via the command line with either `curl` or
`wget`. Naturally `git` is also required.
#### Via Curl
If you're using `curl` type the following command:
`curl -L https://github.com/bbatsov/emacs-prelude/raw/master/utils/installer.sh | sh`
#### Via Wget
If you're using `wget` type:
`wget --no-check-certificate https://github.com/bbatsov/emacs-prelude/raw/master/utils/installer.sh -O - | sh`
### Manual
```bash
$ git clone git://github.com/bbatsov/emacs-prelude.git path/to/local/repo
$ ln -s path/to/local/repo ~/.emacs.d
$ cd ~/emacs.d
$ git submodule init
$ git submodule update
```
You'd do well to replace `~/.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.
You might have to install the `make` and `makeinfo` packages if you
don't have them already, since the build of some packages obtained via
`el-get` might require them.
## Running
Nothing fancy here. Just start Emacs as usual. Personally I run Emacs
in daemon mode:
`$ emacs --daemon`
Afterwards I connect to the server with either a terminal or a GUI
client like this:
```bash
$ emacsclient -t
$ emacsclient -c
```
You'd probably do well to put a few aliases in your `.zshrc` (or
`.bashrc`):
```bash
alias e=emacsclient -t
alias ec=emacsclient -c
alias vim=emacsclient -t
alias vi=emacsclient -t
```
The last two aliases are helpful if you're used to editing files from
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
Emacs 24 ships with a new theming facility that effectively renders
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
load-theme` command. Emacs Prelude adds two more popular themes to the
mix - [Zenburn](https://github.com/bbatsov/zenburn-emacs) and
[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
at your discretion. Why Zenburn? I (and lots of hackers around the
world) find it pretty neat for some reason. Personally I find the
default theme pretty tiresome for the eyes, that's why I took that
"controversial" decision to replace it. You can, of course, easily go
back to the default (or select another theme entirely).
To disable Zenburn just put in your personal config the following
line:
```elisp
(disable-theme 'zenburn)
```
Or you can use another theme altogether by adding something like:
```elisp
(load-theme 'solarized-dark t)
```
## Personalizing
If you'd like to change some of the setting in Prelude (or simply add
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
automatically be Prelude on startup. The directory is backed by a git
submodule, so you can easily track your own personalizations via
git.
Avoid modifying the Prelude config itself (unless you're not
intimidated to maintain a personal fork on GitHub) - this will make it
hard for you to receive automatic updates in the future.
## Caveats & Pitfalls
### Problems with flyspell-mode
Prelude makes heavy use of the flyspell-mode package for spell
checking of various things. The proper operation of flyspell depends
on the presence of the `aspell` program and an `en` dictionary on your
system. You can install `aspell` and the dictionary on OS X with
`homebrew` like this:
```bash
$ brew install aspell --lang=en
```
On Linux distros - just use your distro's package manager.
### Ugly colors in the terminal Emacs version
If your Emacs looks considerably uglier in a terminal (compared to the
GUI version) try adding this to your `.bashrc` or `.zshrc`:
```bash
export TERM=xterm-256color
```
Source the `.bashrc` file and start Emacs again.
### Marmalade error on initial startup
If you get some http connection error related to the Marmalade repo
just do a manual `M-x package-refresh-contents` and restart Emacs
afterwards.
### No arrow navigation in editor buffers
This is not a bug - it's a feature! I firmly believe that the one true
way to use Emacs is by using it the way it was intended to be used (as
far as navigation is concerned at least). That's why I've disabled all
movement commands with arrows - to prevent you from being tempted to
use them.
If you'd still like to use the arrow keys just invoke `M-x
prelude-restore-arrow-keys` to enable them for the duration of your
current Emacs session or add `(prelude-restore-arrow-keys)` to your
personal Emacs customization to enable them permanently.
### Windows compatibility
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
time. This situation will probably improve over time.
## Share the knowledge
[WikEmacs](http://wikemacs.org) collects useful resources for working
with GNU Emacs. Please, take the time to peruse and improve them as
you accumulate knowledge about Emacs. Prelude makes this especially
easy, since it bundles
[MediaWiki support](http://wikemacs.org/wiki/Mediawiki.el) + the
settings required to access WikEmacs right away.
Check out the [Prelude's project page](http://batsov.com/emacs-prelude).
## Known issues ## Known issues

Write Preview
Loading…
Cancel
Save