Skip to content

Commit

Permalink
[Fix #596] Improve personal config instructions (#1202)
Browse files Browse the repository at this point in the history
  • Loading branch information
hiteshjasani authored and bbatsov committed Oct 18, 2018
1 parent d5c1d2b commit 2e6721a
Showing 1 changed file with 31 additions and 6 deletions.
37 changes: 31 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -359,7 +359,7 @@ For subsequent operations, only the appropriate operations (i.e. `+`, `-`, `*`,

Prelude does not mess by default with the standard mapping of `Command` (to `Super`) and `Option` (to `Meta`).

If you want to swap them add this to your personal config:
If you want to swap them add this to your [personal config](#personalizing):

```lisp
(setq mac-command-modifier 'meta)
Expand Down Expand Up @@ -516,8 +516,8 @@ 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:
To disable Zenburn just put in your [personal config](#personalizing)
the following line:

```lisp
(disable-theme 'zenburn)
Expand Down Expand Up @@ -546,6 +546,31 @@ Finally, if you don't want any theme at all, you can add this to your

### Personalizing

All files you create under the `personal/` directory are yours for
personalization. There is no single special personal config file --
any files you create in the `personal/` directory will be loaded in
lexicographical order. The overall loading precedence is:

1. `personal/preload/*`
2. `core/`
3. `prelude-modules.el`
4. `personal/*`

#### Personalization Example

Suppose you want to configure go-mode to autoformat on each save. You
can create a file in `personal/`, let's call this one
`config-go-mode.el` and add the following to it.

``` emacs-lisp
(add-hook 'go-mode-hook
(lambda ()
(add-hook 'before-save-hook 'gofmt-before-save)
(setq tab-width 2)))
```

#### Tips

**Fork** (instead of cloning) the official Prelude repo and add your
own touch to it. You're advised to **avoid changing stuff outside of
the personal folder** to avoid having to deal with git merge conflicts
Expand Down Expand Up @@ -655,14 +680,14 @@ way to use Emacs is by using it the way it was intended to be used (as
far as navigation is concerned at least).

If you'd like to be take this a step further and disable the arrow key navigation
completely put this in your personal config:
completely put this in your [personal config](#personalizing):

```lisp
(setq guru-warn-only nil)
```

To disable `guru-mode` completely add the following snippet to your
personal Emacs config:
[personal config](#personalizing):

```lisp
(setq prelude-guru nil)
Expand All @@ -672,7 +697,7 @@ personal Emacs config:

Prelude overrides `C-a` to behave as described
[here](http://emacsredux.com/blog/2013/05/22/smarter-navigation-to-the-beginning-of-a-line/). If
you don't like that simply add this to your personal config:
you don't like that simply add this to your [personal config](#personalizing):

```lisp
(global-set-key [remap move-beginning-of-line]
Expand Down

0 comments on commit 2e6721a

Please sign in to comment.