emacs-prelude/README.md

81 lines
2.6 KiB
Markdown
Raw Normal View History

2012-03-07 17:58:28 +02:00
```
2012-05-01 15:27:02 +03:00
____ _ _
| _ \ _ __ ___| |_ _ __| | ___
| |_) | '__/ _ \ | | | |/ _` |/ _ \
| __/| | | __/ | |_| | (_| | __/
|_| |_| \___|_|\__,_|\__,_|\___|
2012-03-07 17:58:28 +02:00
```
2011-10-08 00:55:49 +03:00
2011-10-09 22:26:20 +03:00
Emacs is probably the best text editor in the world. However, the
2011-10-08 00:55:49 +03:00
process of coming up with a useful Emacs configuration is long and
difficult. It's this process that separates you from truly taking
advantage of Emacs's power. I like to refer to this process as the
2012-04-17 20:23:53 +03:00
**Prelude**. **Prelude** has the goal to ease the initial Emacs setup
process and to provide you with a much more powerful and productive
experience than that you get out of the box. By using **Prelude**
you're basically getting a "Get me out of the Prelude, I just want to
use Emacs" card.
2011-10-08 00:55:49 +03:00
2012-04-17 20:23:53 +03:00
**Prelude** is compatible **ONLY with GNU Emacs 24**. While Emacs 24
2011-10-08 00:55:49 +03:00
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
use Emacs 24!
2012-02-17 15:07:54 +02:00
## Fast Forward
2012-02-24 15:22:39 +02:00
Assuming you're using an Unix-like OS (`*BSD`, `GNU/Linux`, `OS X`, `Solaris`,
2012-02-17 15:14:32 +02:00
etc), you already have Emacs 24 installed, as well as `git` & `curl` you
2012-02-17 15:07:54 +02:00
can skip the whole manual and just type in your favorite shell the
following command:
2012-02-17 15:14:32 +02:00
`curl -L
2012-04-17 20:23:53 +03:00
https://github.com/bbatsov/prelude/raw/master/utils/installer.sh
2012-02-17 15:14:32 +02:00
| sh`
You can now power up your Emacs, sit back and enjoy Prelude.
2012-02-17 15:07:54 +02:00
There are two environment variables you can use to control the
source repository and the installation directory. For instance:
`PRELUDE_URL="https://github.com/yourname/prelude.git" &&
PRELUDE_INSTALL_DIR="$HOME/.emacs.d" &&
curl -L
https://github.com/bbatsov/prelude/raw/master/utils/installer.sh
| sh`
## Would you like to know more?
2011-10-08 00:55:49 +03:00
2012-05-01 15:27:02 +03:00
Check out the [Prelude's project page](http://batsov.com/prelude) for
all the gory details.
If you're looking for more info on Emacs in general - consult
[WikEmacs](http://wikemacs.org).
## More goodies
The [Prelude Modules](https://github.com/bbatsov/prelude-modules)
2012-05-01 15:33:05 +03:00
project contains a lot of additional packages for Prelude
(install-able via the `package-list-packages` command) - enhanced programming
mode configs, latex config, erc config, etc.
2012-03-30 15:46:01 +03:00
2011-10-08 00:55:49 +03:00
## Known issues
2012-02-27 12:20:54 +02:00
Check out the project's
2012-04-17 20:23:53 +03:00
[issue list](https://github.com/bbatsov/prelude/issues?sort=created&direction=desc&state=open)
2012-02-27 12:20:54 +02:00
a list of unresolved issues. By the way - feel free to fix any of them
and sent me a pull request. :-)
2012-02-17 15:07:54 +02:00
## Contributors
2012-04-17 20:23:53 +03:00
Here's a [list](https://github.com/bbatsov/prelude/contributors) of all the people who have contributed to the
2012-02-17 15:07:54 +02:00
development of Emacs Prelude.
2011-10-08 00:55:49 +03:00
## Bugs & Improvements
Bug reports and suggestions for improvements are always
2012-05-01 15:27:02 +03:00
welcome. GitHub pull requests are even better! :-)
2011-10-08 00:55:49 +03:00
2012-02-24 15:22:39 +02:00
Cheers,<br>
2011-10-08 00:55:49 +03:00
Bozhidar