Skip to content

Commit

Permalink
Merge branch 'master' of github.com:bbatsov/prelude
Browse files Browse the repository at this point in the history
* 'master' of github.com:bbatsov/prelude:
  Add the prelude-rust.el module (bbatsov#1102)
  Mentioned requirement of having no ~/.emacs file.
  Upgrade prelude-common-lisp.el (bbatsov#1099)
  [Fix bbatsov#1096] Remove ido-ubiquitous and add ido-completing-read+ (bbatsov#1100)
  Making the prelude-erc module more modular
  Refine missing bundled example file warning (bbatsov#1094)
  Fix message about location of prelude-modules.el after install
  Emacs latest release is 25.2
  Use elpa repository for 'queue' and 'spinner' packages
  Add stanza inserted by Package.el cf. bbatsov#1056
  [Fix bbatsov#743] Add support for package pinning (bbatsov#1048)
  Update the copyright years
  Code style
  Use http protocol instead of https for ELPA on Windows
  Disable Flycheck warnings for `personal`
  Use settings from .editorconfig file (bbatsov#1008)
  Don't alter C-a binding in orgmode
  Update saveplace to work with Emacs 25 (bbatsov#1046)
  Ignore emacs desktop files (bbatsov#1044)
  [Fix bbatsov#1004] Correct the Salt link in the README
  [Fix bbatsov#1012] Update a reference to a crux function
  Update the README for Emacs 25
  Rename .emacs if it exists in the installer(bbatsov#1037)
  Add helm-occur-from-isearch to isearch-mode-map (bbatsov#1030)
  Wrap kill-region with defadvice from crux (bbatsov#1035)
  pretzo -> prezto (bbatsov#1034)
  Add kotlin-mode to the auto-install list (bbatsov#1016)
  Fix a broken link in README.md (bbatsov#1007)
  Add a gratipay badge
  Make the scala-mode dependency explicit
  Remove a mention of scala-mode2
  Update the donation options
  Replace `scala-mode2` with the `ensime` package (bbatsov#1001)
  Update README.md (bbatsov#996)
  Fix the crux-like changes (bbatsov#995)
  Change function name to crux (bbatsov#992)
  Auto-install cask-mode when needed
  Fix C-a behavior (bbatsov#991)
  Replace some of the bundled code with the crux package
  [bbatsov#956] Mention that Emacs 24.4 is required
  Improve code style a bit
  [Fix bbatsov#989] Use eldoc-mode instead of haskell-doc-mode
  Fix some auto-pairing issues when editing erb file with web-mode (bbatsov#805)
  • Loading branch information
suutari committed Jul 31, 2017
2 parents 66e3b35 + bfee536 commit b82a7f2
Show file tree
Hide file tree
Showing 50 changed files with 446 additions and 476 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,5 @@ session*
.cask
tramp
/var/pcache
.emacs.desktop
.emacs.desktop.lock
65 changes: 40 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[![License GPL 3][badge-license]](http://www.gnu.org/licenses/gpl-3.0.txt)
[![Gratipay](http://img.shields.io/gratipay/bbatsov.svg)](https://gratipay.com/bbatsov/)
[![Gratipay Team](https://img.shields.io/gratipay/team/prelude.svg?maxAge=2592000)](https://gratipay.com/prelude/)

Emacs Prelude
=============
Expand All @@ -13,14 +13,20 @@ 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
Prelude is compatible **ONLY with GNU Emacs 24.4+**. In general you're
advised to always run Prelude with the latest Emacs - currently
**24.5**.
**25.2**.

You can support the development of Prelude via
[Salt](https://bountysource.com/teams/prelude) and
[Gratipay](https://www.gratipay.com/prelude).

[![Support via Gratipay](https://cdn.rawgit.com/gratipay/gratipay-badge/2.1.3/dist/gratipay.png)](https://gratipay.com/prelude)

**Table of Contents**

- [Fast Forward](#fast-forward)
- [Installing Emacs 24](#installing-emacs-24)
- [Installing Emacs](#installing-emacs)
- [Installation](#installation)
- [Automated](#automated)
- [Via Curl](#via-curl)
Expand Down Expand Up @@ -53,7 +59,7 @@ advised to always run Prelude with the latest Emacs - currently
- [Problems with flyspell-mode](#problems-with-flyspell-mode)
- [Ugly colors in the terminal Emacs version](#ugly-colors-in-the-terminal-emacs-version)
- [MELPA error on initial startup](#melpa-error-on-initial-startup)
- [Warnings on arrow navigation in editor buffers](#warnings-on-navigation-in-editor-buffers)
- [Warnings on arrow navigation in editor buffers](#warnings-on-arrow-navigation-in-editor-buffers)
- [Customized C-a behavior](#customized-c-a-behavior)
- [Poor ido matching performance on large datasets](#poor-ido-matching-performance-on-large-datasets)
- [Windows compatibility](#windows-compatibility)
Expand All @@ -65,7 +71,7 @@ advised to always run Prelude with the latest Emacs - currently
## 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
etc), you already have Emacs 24.4+ installed, as well as `git` & `curl` you
can skip the whole manual and just type in your favorite shell the
following command:

Expand Down Expand Up @@ -98,10 +104,12 @@ 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
## Installing Emacs

Obviously to use the Emacs Prelude you have to install Emacs 24
first. Have a look at the [WikEmacs articles on installing Emacs](http://wikemacs.org/index.php/Installing_Emacs).
Obviously to use the Emacs Prelude you have to install Emacs
first. Have a look at
the
[WikEmacs articles on installing Emacs](http://wikemacs.org/index.php/Installing_Emacs).

## Installation

Expand All @@ -128,6 +136,8 @@ wget --no-check-certificate https://github.com/bbatsov/prelude/raw/master/utils/

### Manual

Make sure you do not have any `~/.emacs` file present.

```bash
git clone git://github.com/bbatsov/prelude.git path/to/local/repo
ln -s path/to/local/repo ~/.emacs.d
Expand Down Expand Up @@ -166,6 +176,15 @@ there are such).

Simply run <kbd>M-x prelude-update</kbd> from Emacs itself and restart Emacs afterwards.

## Pinning packages

By default, Prelude will install packages from the melpa and gnu package
repositories. Occasionally package integration can break when upgrading packages.
This can be avoided by pinning packages to stable versions in other repositories.
To do so, copy `prelude-pinned-packages.el` from the sample directory to
Prelude's root directory and adjust the [variables](https://www.gnu.org/software/emacs/manual/html_node/emacs/Package-Installation.html)
inside accordingly.

## 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](modules/doc/README.md).
Expand Down Expand Up @@ -265,7 +284,7 @@ Keybinding | Description
<kbd>C-+</kbd> | Increase font size(`text-scale-increase`).
<kbd>C--</kbd> | Decrease font size(`text-scale-decrease`).
<kbd>C-x O</kbd> | Go back to previous window (the inverse of `other-window` (`C-x o`)).
<kbd>C-^</kbd> | Join two lines into one(`prelude-top-join-line`).
<kbd>C-^</kbd> | Join two lines into one(`crux-top-join-line`).
<kbd>C-x p</kbd> | Start `proced` (manage processes from Emacs; works only in Linux).
<kbd>C-x m</kbd> | Start `eshell`.
<kbd>C-x M-m</kbd> | Start your default shell.
Expand All @@ -281,7 +300,7 @@ Keybinding | Description
<kbd>C-x M-g</kbd> | Open Magit's popup of popups.
<kbd>M-Z</kbd> | Zap up to char.
<kbd>C-=</kbd> | Run `expand-region` (incremental text selection).
<kbd>C-a</kbd> | Run `prelude-move-beginning-of-line`. Read [this](http://emacsredux.com/blog/2013/05/22/smarter-navigation-to-the-beginning-of-a-line/) for details.
<kbd>C-a</kbd> | Run `crux-move-beginning-of-line`. Read [this](http://emacsredux.com/blog/2013/05/22/smarter-navigation-to-the-beginning-of-a-line/) for details.

#### Prelude Mode

Expand Down Expand Up @@ -432,7 +451,7 @@ Keybinding | Description
<kbd>jj</kbd> | Jump to the beginning of a word(`avy-goto-word-1`)
<kbd>jk</kbd> | Jump to a character(`avy-goto-char`)
<kbd>jl</kbd> | Jump to the beginning of a line(`avy-goto-line`)
<kbd>JJ</kbd> | Jump back to previous buffer(`prelude-switch-to-previous-buffer`)
<kbd>JJ</kbd> | Jump back to previous buffer(`crux-switch-to-previous-buffer`)
<kbd>uu</kbd> | View edits as a tree(`undo-tree-visualize`)
<kbd>xx</kbd> | Executed extended command(`execute-extended-command`)
<kbd>yy</kbd> | Browse the kill ring(`browse-kill-ring`)
Expand Down Expand Up @@ -471,17 +490,17 @@ You can, of course, install anything you wish manually as well.

### 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
Emacs provides a dozen of
built-in themes you can use out-of-the-box by invoking the `M-x
load-theme` command.

[Zenburn](https://github.com/bbatsov/zenburn-emacs) 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).
[Zenburn](https://github.com/bbatsov/zenburn-emacs) 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:
Expand Down Expand Up @@ -663,7 +682,7 @@ You can always disable the improved sorting algorithm all together like this:
### 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
with Linux & OS X, so there are Windows related problems from time to
time. This situation will probably improve over time.

## Known issues
Expand All @@ -689,10 +708,6 @@ development of Emacs Prelude.
Bug reports and suggestions for improvements are always
welcome. GitHub pull requests are even better! :-)

I'm also accepting financial contributions via [gittip](https://www.gittip.com/bbatsov).

[![Support via Gittip](https://rawgithub.com/twolfson/gittip-badge/0.2.0/dist/gittip.png)](https://www.gittip.com/bbatsov)

Cheers,<br/>
[Bozhidar](https://twitter.com/bbatsov)

Expand Down
Loading

0 comments on commit b82a7f2

Please sign in to comment.