2014-05-26 19:06:52 +03:00
|
|
|
[![License GPL 3][badge-license]](http://www.gnu.org/licenses/gpl-3.0.txt)
|
2017-12-29 19:21:55 +02:00
|
|
|
[![Patreon](https://img.shields.io/badge/patreon-donate-orange.svg)](https://www.patreon.com/bbatsov)
|
2014-04-25 09:35:04 +03:00
|
|
|
|
2012-09-16 14:52:48 +03:00
|
|
|
Emacs Prelude
|
|
|
|
=============
|
2012-09-05 13:41:54 +03:00
|
|
|
|
2013-03-17 11:58:17 +02:00
|
|
|
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.
|
2011-10-08 00:55:49 +03:00
|
|
|
|
2018-07-10 09:01:24 +03:00
|
|
|
Prelude is compatible **ONLY with GNU Emacs 25.1+**. In general you're
|
2020-09-03 09:05:17 +03:00
|
|
|
advised to always run Prelude with the latest stable Emacs release.
|
2011-10-08 00:55:49 +03:00
|
|
|
|
2016-05-28 14:30:42 +03:00
|
|
|
You can support the development of Prelude via
|
2020-09-03 09:22:32 +03:00
|
|
|
[GitHub Sponsors](https://github.com/sponsors/bbatsov),
|
2019-05-29 09:22:46 +03:00
|
|
|
[PayPal](https://www.paypal.me/bbatsov) and
|
|
|
|
[Patreon](https://www.patreon.com/bbatsov).
|
2016-05-28 14:30:42 +03:00
|
|
|
|
2020-09-03 09:04:24 +03:00
|
|
|
## Features
|
|
|
|
|
|
|
|
* Improved UX, that's still in line with Emacs traditions
|
|
|
|
* Sane defaults of baseline Emacs functionality
|
2020-09-03 09:22:32 +03:00
|
|
|
* Automatic installation of many major programming modes on demand
|
2020-09-03 09:04:24 +03:00
|
|
|
* A curated set of 3rd party packages to enhance the base functionality
|
|
|
|
* Simple modular architecture
|
|
|
|
* Easy customization
|
|
|
|
|
2012-09-16 14:52:48 +03:00
|
|
|
## Fast Forward
|
2012-02-17 15:07:54 +02:00
|
|
|
|
2017-12-29 20:02:10 +02:00
|
|
|
Assuming you're using an Unix-like OS (`*BSD`, `GNU/Linux`, `macOS`, `Solaris`,
|
2020-04-13 08:29:57 +03:00
|
|
|
etc), you already have a recent version of Emacs 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:
|
|
|
|
|
2020-09-03 09:22:32 +03:00
|
|
|
```shellsession
|
|
|
|
$ curl -L https://git.io/epre | sh
|
2012-09-16 13:16:37 +03:00
|
|
|
```
|
2012-02-17 15:14:32 +02:00
|
|
|
|
2020-04-13 08:29:57 +03:00
|
|
|
You can now power up your Emacs, sit back and enjoy Prelude.
|
2012-02-17 15:07:54 +02:00
|
|
|
|
2013-01-07 14:48:14 +02:00
|
|
|
There are two environment variables you can use to control the
|
|
|
|
source repository and the installation directory. To change the
|
2012-06-08 22:00:32 +03:00
|
|
|
installation directory:
|
2012-06-08 21:56:15 +03:00
|
|
|
|
2020-09-03 09:22:32 +03:00
|
|
|
```shellsession
|
|
|
|
$ export PRELUDE_INSTALL_DIR="$HOME/.emacs.d" && curl -L https://github.com/bbatsov/prelude/raw/master/utils/installer.sh | sh
|
2012-09-16 13:16:37 +03:00
|
|
|
```
|
2012-06-08 22:00:32 +03:00
|
|
|
|
|
|
|
To change the source repository:
|
|
|
|
|
2020-09-03 09:22:32 +03:00
|
|
|
```shellsession
|
|
|
|
$ export PRELUDE_URL="https://github.com/yourname/prelude.git" && curl -L https://github.com/bbatsov/prelude/raw/master/utils/installer.sh | sh
|
2012-09-16 13:16:37 +03:00
|
|
|
```
|
2012-06-08 21:56:15 +03:00
|
|
|
|
2012-06-14 14:28:28 +03:00
|
|
|
Note that the installer will back up any existing `.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.
|
2012-06-08 21:56:15 +03:00
|
|
|
|
2020-04-13 08:29:57 +03:00
|
|
|
**Important:** Don't forget to adjust your `prelude-modules.el` file in your personal directory
|
2018-11-20 23:39:57 +02:00
|
|
|
once the installation is done. By default most of the modules
|
2020-04-13 08:29:57 +03:00
|
|
|
that ship with Prelude are **not** loaded.
|
2013-01-13 20:42:17 +02:00
|
|
|
|
2020-09-03 09:04:24 +03:00
|
|
|
## Philosophy
|
|
|
|
|
|
|
|
Prelude's philosophy is quite simple:
|
|
|
|
|
|
|
|
* simple
|
|
|
|
* easy to understand and extend
|
|
|
|
* stable
|
|
|
|
* a foundation for you to build upon, as opposed to some end-user product
|
|
|
|
|
|
|
|
This means that it intentionally doesn't pack all the bells and whistles that it could.
|
|
|
|
Prelude aims to enhance the classic Emacs experience without deviating a lot from it - e.g.
|
|
|
|
it would never enable something like `evil-mode` (vim keybindings) by default and so on.
|
|
|
|
|
|
|
|
All the third-party packages that it bundles are carefully vetted and are known to be of
|
|
|
|
good quality and to have reliable maintainers. That generally means that Prelude's unlikely
|
|
|
|
to immediate adopt some shiny new package, that has established tried and true alternatives.
|
|
|
|
|
2019-01-16 15:06:45 +02:00
|
|
|
## User Manual
|
|
|
|
|
2020-04-13 08:29:57 +03:00
|
|
|
While Emacs Prelude is pretty simple at its core, it does have some specifics that
|
|
|
|
are worth learning - e.g. configuration options, load order of modules and personal settings
|
|
|
|
and so on.
|
|
|
|
|
2019-01-16 15:06:45 +02:00
|
|
|
Check out our [user manual](https://prelude.emacsredux.com) for more information.
|
|
|
|
|
2020-09-15 08:37:43 +03:00
|
|
|
You can also find a lot of information about specific Prelude features and the rationale behind them on
|
|
|
|
my Emacs blog [Emacs Redux](https://emacsredux.com).
|
|
|
|
|
|
|
|
## crux and super-save
|
|
|
|
|
|
|
|
A lot of utility commands that used to be part of Prelude were eventually extracted to the [crux](https://github.com/bbatsov/crux) package,
|
|
|
|
so they'd be easily available to more people.
|
|
|
|
These days Prelude simply depends on that package.
|
|
|
|
|
|
|
|
The [super-save](https://github.com/bbatsov/super-save) package also used to be part of Prelude in the past.
|
|
|
|
|
2012-09-16 14:52:48 +03:00
|
|
|
## Known issues
|
2011-10-08 00:55:49 +03:00
|
|
|
|
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
|
2012-09-16 13:16:37 +03:00
|
|
|
and send me a pull request. :-)
|
2012-02-17 15:07:54 +02:00
|
|
|
|
2012-09-26 14:07:32 +03:00
|
|
|
## Support
|
|
|
|
|
2017-12-29 16:58:49 +02:00
|
|
|
Support is available via several channels:
|
2014-05-10 14:59:44 +03:00
|
|
|
|
2017-12-29 16:58:49 +02:00
|
|
|
* Prelude's Google Group <emacs-prelude@googlegroups.com>
|
|
|
|
* Prelude's Freenode channel (`#prelude-emacs`)
|
|
|
|
* [Gitter](https://gitter.im/bbatsov/prelude)
|
2018-04-03 11:00:45 +03:00
|
|
|
|
2012-09-16 14:52:48 +03:00
|
|
|
## Contributors
|
2012-02-17 15:07:54 +02:00
|
|
|
|
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
|
|
|
|
2012-09-16 14:52:48 +03:00
|
|
|
## Bugs & Improvements
|
2011-10-11 21:09:02 +03:00
|
|
|
|
|
|
|
Bug reports and suggestions for improvements are always
|
2012-09-16 13:16:37 +03:00
|
|
|
welcome. GitHub pull requests are even better! :-)
|
2011-10-08 00:55:49 +03:00
|
|
|
|
2020-06-10 12:44:49 +03:00
|
|
|
## License
|
|
|
|
|
|
|
|
Copyright © 2011-2020 Bozhidar Batsov and
|
|
|
|
[contributors](https://github.com/bbatsov/prelude/contributors).
|
|
|
|
|
|
|
|
Distributed under the GNU General Public License, version 3
|
2014-05-26 19:06:52 +03:00
|
|
|
|
|
|
|
[badge-license]: https://img.shields.io/badge/license-GPL_3-green.svg
|