diff --git a/docs/installation.md b/docs/installation.md index 5e5dd73..b4725d5 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -22,7 +22,7 @@ All those tools are completely optional, though. Additional external tools might be needed by some of the modules (e.g. tools specific to particular programming languages, etc). -## Installation +## Installing Prelude ### Automated @@ -34,10 +34,12 @@ The installer script will do the following: * Clone Prelude's GitHub repo * Check your Emacs version * Backup any existing `.emacs` or `.emacs.d` you might have -* Create any additional folders if necessary (e.g. for storing package-specific data) +* Create any additional folders if necessary (e.g. for storing + package-specific data) -If you have a `.emacs` file it will backed up as `.emacs.pre-prelude` and if you have -a `.emacs.d` folder, it will be backed up as `.emacs.d.pre-prelude.tar`. +If you have a `.emacs` file it will backed up as `.emacs.pre-prelude` +and if you have a `.emacs.d` folder, it will be backed up as +`.emacs.d.pre-prelude.tar`. #### Via Curl @@ -57,7 +59,8 @@ $ wget --no-check-certificate https://github.com/bbatsov/prelude/raw/master/util ### Manual -Make sure you do not have any `~/.emacs` file or `~/.emacs.d` folder present. +Make sure you do not have any `~/.emacs` file or `~/.emacs.d` folder +present. ```shellsession $ git clone git://github.com/bbatsov/prelude.git path/to/local/repo @@ -91,66 +94,109 @@ place your configuration files. ## Pinning packages -By default, Prelude will install packages from the MELPA and GNU ELPA package -repositories. Occasionally package integration can break when upgrading packages, -as the packages in the MELPA repository are all snapshot builds. -This can be avoided by pinning packages to stable versions in other repositories (e.g. MELPA Stable). -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) +By default, Prelude will install packages from the MELPA and GNU ELPA +package repositories. Occasionally package integration can break when +upgrading packages, as the packages in the MELPA repository are all +snapshot builds. This can be avoided by pinning packages to stable +versions in other repositories (e.g. MELPA Stable). 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/index.md). +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/index.md). ```lisp ;;; Uncomment the modules you'd like to use and restart Prelude afterwards +;;; General productivity tools + +;; (require 'prelude-ido) ;; Supercharges Emacs completion for C-x C-f and more +(require 'prelude-ivy) ;; A mighty modern alternative to ido +;; (require 'prelude-selectrum) ;; A powerful, yet simple, alternative to ivy +;; (require 'prelude-helm) ;; Interface for narrowing and search +;; (require 'prelude-helm-everywhere) ;; Enable Helm everywhere +(require 'prelude-company) +;; (require 'prelude-key-chord) ;; Binds useful features to key combinations + +;;; Vim emulation +;; +;; Enable this module if you're fond of vim's keybindings. +;; (require 'prelude-evil) + +;;; Org-mode (a legendary productivity tool that deserves its own category) +;; +;; Org-mode helps you keep TODO lists, notes and more. +(require 'prelude-org) + +;;; Programming languages support +;; +;; Modules for a few very common programming languages +;; are enabled by default. + (require 'prelude-c) ;; (require 'prelude-clojure) ;; (require 'prelude-coffee) ;; (require 'prelude-common-lisp) -;; (require 'prelude-css) +(require 'prelude-css) +;; (require 'prelude-dart) (require 'prelude-emacs-lisp) -(require 'prelude-erc) ;; (require 'prelude-erlang) ;; (require 'prelude-elixir) +;; (require 'prelude-go) ;; (require 'prelude-haskell) (require 'prelude-js) ;; (require 'prelude-latex) -(require 'prelude-lisp) -(require 'prelude-org) +(require 'prelude-lisp) ;; Common setup for Lisp-like languages +(require 'prelude-lsp) ;; Base setup for the Language Server Protocol +;; (require 'prelude-lua) +;; (require 'prelude-ocaml) (require 'prelude-perl) ;; (require 'prelude-python) +;; (require 'prelude-racket) ;; (require 'prelude-ruby) +;; (require 'prelude-rust) ;; (require 'prelude-scala) -(require 'prelude-scheme) +;; (require 'prelude-scheme) +(require 'prelude-shell) ;; (require 'prelude-scss) -;; (require 'prelude-web) +;; (require 'prelude-ts) +(require 'prelude-web) ;; Emacs mode for web templates (require 'prelude-xml) +(require 'prelude-yaml) + +;;; Misc +(require 'prelude-erc) ;; A popular Emacs IRC client (useful if you're still into Freenode) ``` -You'll need to adjust your `prelude-modules.el` file once the installation is done. +You'll need to adjust your `prelude-modules.el` file once the +installation is done. -In case of an automated installation, you'll find this file in the `personal` directory of your Emacs installation. +In case of an automated installation, you'll find this file in the +`personal` directory of your Emacs installation. -If you are doing a manual install then you first -need to copy the `prelude-modules.el` available in the sample -directory to the root of `path/to/prelude/installation` and then -adjust that one. +If you are doing a manual install then you first need to copy the +`prelude-modules.el` available in the sample directory to the root of +`path/to/prelude/installation` and then adjust that one. -After you've uncommented a module you should either restart Emacs or evaluate the module -`require` expression with C-x C-e. +After you've uncommented a module you should either restart Emacs or +evaluate the module `require` expression with C-x C-e. ## Updating Prelude ### Automatic update -Simply run M-x prelude-update from Emacs itself and restart Emacs afterwards. +Simply run M-x prelude-update from Emacs itself and restart +Emacs afterwards. ### Manual update -The update procedure is fairly straightforward and consists of 3 steps: +The update procedure is fairly straightforward and consists of 3 +steps: #### Update all bundled packages @@ -179,6 +225,7 @@ there are such). ## Uninstalling Prelude -Provided you've installed Prelude in `.emacs.d`, all you need to do is delete that folder. -If you opted for the manual installation and making `.emacs.d` a symlink - you remove/update -the link. Yeah, it's as simple as that. No fancy uninstaller required! +Provided you've installed Prelude in `.emacs.d`, all you need to do is +delete that folder. If you opted for the manual installation and +making `.emacs.d` a symlink - you remove/update the link. Yeah, it's +as simple as that. No fancy uninstaller required!