jt/emacs-prelude
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
1327 commits 2 branches 0 tags 4.9 MiB
Emacs Lisp 95.2%
Shell 4.8%
Find a file
weiyang 1ec6780478 Fix the link of 'prelude-cheatsheet.pdf' 
Signed-off-by: weiyang <weiyang.ones@gmail.com>
2019-01-26 07:24:50 -04:00
core [Fix #1171] Add gnu/linux specific module and exec-path-from-shell support on linux (#1203) 2018-10-23 00:19:31 +02:00
doc Tweak some markup 2019-01-16 19:04:56 +02:00
modules Restructure the README into a manual 2019-01-16 14:55:53 +02:00
personal Disable Flycheck warnings for personal 2017-01-04 01:14:32 +02:00
sample Rust Language Server (RLS) support 2018-11-21 10:11:19 +01:00
themes restored accidentally deleted dirs 2012-06-23 13:01:00 +03:00
utils Move prelude-modules.el under personal directory 2018-11-21 10:10:06 +01:00
vendor Don't use dash.el during package init 2013-04-25 15:13:52 +03:00
.gitignore Move prelude-modules.el under personal directory 2018-11-21 10:10:06 +01:00
.projectile [Fix #447] Extract ido config into a module 2013-12-06 17:10:04 +02:00
CONTRIBUTING.md added contribution guidelines 2013-01-05 14:38:32 +02:00
init.el [Fix #1208] Correct RegExp collisions while loading personal config. 2018-11-24 09:49:21 +00:00
mkdocs.yml Restructure the README into a manual 2019-01-16 14:55:53 +02:00
prelude-cheatsheet.pdf Fix the link of 'prelude-cheatsheet.pdf' 2019-01-26 07:24:50 -04:00
README.md Mention the new manual in the README 2019-01-16 15:06:45 +02:00

README.md

License GPL 3 Liberapay Patreon

Emacs Prelude

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.

Prelude is compatible ONLY with GNU Emacs 25.1+. In general you're advised to always run Prelude with the latest Emacs - currently 26.1.

You can support the development of Prelude via PayPal, Salt, Patreon and Liberapay.

Liberapay Patreon

Fast Forward

Assuming you're using an Unix-like OS (*BSD, GNU/Linux, macOS, Solaris, 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:

curl -L https://git.io/epre | sh

You can now power up your Emacs, sit back and enjoy Prelude, forgetting about the rest of this manual.

There are two environment variables you can use to control the source repository and the installation directory. To change the installation directory:

export PRELUDE_INSTALL_DIR="$HOME/.emacs.d" && curl -L https://github.com/bbatsov/prelude/raw/master/utils/installer.sh | sh

To change the source repository:

export PRELUDE_URL="https://github.com/yourname/prelude.git" && curl -L https://github.com/bbatsov/prelude/raw/master/utils/installer.sh | sh

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.

Don't forget to adjust your prelude-modules.el file in your personal directory once the installation is done. By default most of the modules that ship with Prelude are not loaded.

User Manual

Check out our user manual for more information.

Known issues

Check out the project's issue list a list of unresolved issues. By the way - feel free to fix any of them and send me a pull request. :-)

Support

Support is available via several channels:

Contributors

Here's a list of all the people who have contributed to the development of Emacs Prelude.

Bugs & Improvements

Bug reports and suggestions for improvements are always welcome. GitHub pull requests are even better! :-)

Cheers,
Bozhidar