-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathREADME
76 lines (62 loc) · 3.7 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
emacs-setup is an emacs package that is meant to help make maintaining your
emacs setup easier. Through the use of M-x customize, the following can be
setup through emacs-setup:
Add/remove directories to the load path.
Add/remove directories to the environment PATH.
Add/remove packages to require, including any accompanying setup elisp code.
Set/unset and save keybindings.
Installation:
The package can be installed with M-x package-list-packages (requires
package.el, which is included for emacs 24 but availble for 23). The MELPA
repository must be added to your packages setup first. Instructions can be found
at http://melpa.milkbox.net/
Alternatively, the source can be pulled direclty from github:
https://github.com/echosa/emacs-setup
If you install via package-list-packages, revive.el will be installed for you.
If you do not, you will need to manually get, install, and load revive.el.
You can find it at http://www.gentei.org/~yuuji/software/revive.el
Usage:
In your .emacs, load emacs-setup:
(load-file "~/path/to/emacs-setup/emacs-setup.el")
Once loaded, you can use M-x customize-group emacs-setup to setup your
environment.
emacs-setup is broken down into several parts, which can each be customized
individually:
emacs-setup - This is the main part of emacs-setup. You can set your base
directory (your .emacs.d or equivalent), directories to ignore
when recursively adding to load path, and various list of
s-expressions (base, pre, post, etc.) The s-expression lists
can be used to setup things that would normally be in your
.emacs, but are not customizable options. For instance,
(set-frame-font), (set-background-color), (transient-mark-mode),
etc. I'm not going to try an support every option of emacs.
Instead, simply add these configuration lines (one sexp per line)
to the appropriate sexp group, depending on when they need to run.
When emacs-setup-base is run, the last thing it does is run all
the s-expressions in emacs-setup-base-sexp. When emacs-setup is
run, it runs in this order:
- emacs-setup-pre-sexp
- require pacakges via emacs-setup-require
- emacs-setup-post-sexp
- bind keys in emacs-setup-keys
emacs-setup-keys - This part of emacs-setup allows you to have your keybindings
all in one place via customize. You can manually add and
remove keybindings, or you can use the functions
emacs-setup-bind-key,
emacs-seutp-unbind-key-by-key, or
emacs-setup-unbind-key-by-functions
to interactively bind or unbind keys, which are saved to
customize for you.
emacs-setup-require - This is ths part of emacs-setup where you can tell it
which packages to load, and give setup s-expressions.
You can customize the load-path and env-path, whether or
not to loade elpa and where your package.el is (if not
using emacs 24). Customizing the variable
emacs-setup-require-list
is where you can add which packages should be load, in
the order you supply them, as well as any configuration
for each package after it is loaded.
When emacs-setup is run, if any pacakges fail to load, a
buffer called *invalid-packages* will be displayed telling
you which failed.
emacs-setup is written and maintained by Brian Zwahr <echosa@gmail.com>