diff --git a/core/templates/config.example.el b/core/templates/config.example.el index 2f1430fde..2f476f919 100644 --- a/core/templates/config.example.el +++ b/core/templates/config.example.el @@ -1,7 +1,7 @@ ;;; $DOOMDIR/config.el -*- lexical-binding: t; -*- ;; Place your private configuration here! Remember, you do not need to run 'doom -;; refresh' after modifying this file! +;; sync' after modifying this file! ;; Some functionality uses this to identify you, e.g. GPG configuration, email @@ -14,7 +14,8 @@ ;; ;; + `doom-font' ;; + `doom-variable-pitch-font' -;; + `doom-big-font' -- used for `doom-big-font-mode' +;; + `doom-big-font' -- used for `doom-big-font-mode'; use this for +;; presentations or streaming. ;; ;; They all accept either a font-spec, font string ("Input Mono-12"), or xlfd ;; font string. You generally only need these two: @@ -22,14 +23,15 @@ ;; There are two ways to load a theme. Both assume the theme is installed and ;; available. You can either set `doom-theme' or manually load a theme with the -;; `load-theme' function. These are the defaults. +;; `load-theme' function. This is the default: (setq doom-theme 'doom-one) -;; If you intend to use org, it is recommended you change this! +;; If you use `org' and don't want your org files in the default location below, +;; change `org-directory'. It must be set before org loads! (setq org-directory "~/org/") -;; If you want to change the style of line numbers, change this to `relative' or -;; `nil' to disable it: +;; This determines the style of line numbers in effect. If set to `nil', line +;; numbers are disabled. For relative line numbers, set this to `relative'. (setq display-line-numbers-type t) @@ -38,8 +40,9 @@ ;; - `load!' for loading external *.el files relative to this one ;; - `use-package' for configuring packages ;; - `after!' for running code after a package has loaded -;; - `add-load-path!' for adding directories to the `load-path', where Emacs -;; looks when you load packages with `require' or `use-package'. +;; - `add-load-path!' for adding directories to the `load-path', relative to +;; this file. Emacs searches the `load-path' when you load packages with +;; `require' or `use-package'. ;; - `map!' for binding new keys ;; ;; To get information about any of these functions/macros, move the cursor over diff --git a/core/templates/packages.example.el b/core/templates/packages.example.el index b0c8dc3eb..2afbc7e28 100644 --- a/core/templates/packages.example.el +++ b/core/templates/packages.example.el @@ -1,23 +1,22 @@ ;; -*- no-byte-compile: t; -*- ;;; $DOOMDIR/packages.el -;; This is where you install packages, by declaring them with the `package!' -;; macro, then running 'doom refresh' on the command line. You'll need to -;; restart Emacs for your changes to take effect! Or at least, run M-x -;; `doom/reload'. +;; To install a package with Doom you must declare them here, run 'doom sync' on +;; the command line, then restart Emacs for the changes to take effect. +;; Alternatively, use M-x doom/reload. ;; -;; WARNING: Don't disable core packages listed in ~/.emacs.d/core/packages.el. -;; Doom requires these, and disabling them may have terrible side effects. -;; -;; Here are a couple examples: +;; WARNING: Disabling core packages listed in ~/.emacs.d/core/packages.el may +;; have nasty side-effects and is not recommended. ;; All of Doom's packages are pinned to a specific commit, and updated from ;; release to release. To un-pin all packages and live on the edge, do: -;(setq doom-pinned-packages nil) +;(unpin! t) ;; ...but to unpin a single package: -;(package! pinned-package :pin nil) +;(unpin! pinned-package) +;; Use it to unpin multiple packages +;(unpin! pinned-package another-pinned-package) ;; To install SOME-PACKAGE from MELPA, ELPA or emacsmirror: