From 1d7ac0e4109a83df2aa054ee89154c2451436fda Mon Sep 17 00:00:00 2001 From: Tom Willemse Date: Thu, 15 Jul 2021 22:34:08 -0700 Subject: [PATCH] Add comments on how to use the packages managed by Guix --- oni-bats/oni-bats.el | 7 +++++-- oni-bookmark.el | 7 +++++-- oni-c.el | 7 +++++-- oni-circe.el | 7 +++++-- oni-core.el | 7 +++++-- oni-elfeed.el | 7 +++++-- oni-embrace.el | 7 +++++-- oni-flycheck.el | 7 +++++-- oni-hydra.el | 6 +++++- oni-lsp.el | 7 +++++-- oni-lui.el | 7 +++++-- oni-sh.el | 6 +++++- oni-smartparens.el | 7 +++++-- oni-vterm.el | 5 ++++- oni-yasnippet.el | 9 +++++++-- 15 files changed, 76 insertions(+), 27 deletions(-) diff --git a/oni-bats/oni-bats.el b/oni-bats/oni-bats.el index fb9e773..80564d7 100644 --- a/oni-bats/oni-bats.el +++ b/oni-bats/oni-bats.el @@ -4,7 +4,7 @@ ;; Author: Tom Willemse ;; Keywords: local -;; Version: 2021.0713.225225 +;; Version: 2021.0715.223146 ;; Package-Requires: (bats-mode oni-sh oni-yasnippet) ;; This program is free software; you can redistribute it and/or modify @@ -25,7 +25,10 @@ ;; Configuration for ‘bats-mode’. ;; This configuration pulls in ‘oni-sh’ because ‘bats-mode’ is derived from -;; ‘sh-mode’. +;; ‘sh-mode’. Add the following to your init file in case you want to use this +;; configuration: +;; +;; (with-eval-after-load 'bats-mode (require 'oni-bats)) ;;; Code: diff --git a/oni-bookmark.el b/oni-bookmark.el index 6f1d269..fbc150f 100644 --- a/oni-bookmark.el +++ b/oni-bookmark.el @@ -4,7 +4,7 @@ ;; Author: Tom Willemse ;; Keywords: local -;; Version: 2021.0527.230116 +;; Version: 2021.0715.223038 ;; Package-Requires: (oni-data-dir) ;; This program is free software; you can redistribute it and/or modify @@ -22,7 +22,10 @@ ;;; Commentary: -;; Bookmark configuration. +;; Bookmark configuration. Add the following to your init file in case you want +;; to use this configuration: +;; +;; (with-eval-after-load 'bookmark (require 'oni-bookmark)) ;;; Code: diff --git a/oni-c.el b/oni-c.el index 5e8f125..676c965 100644 --- a/oni-c.el +++ b/oni-c.el @@ -4,7 +4,7 @@ ;; Author: Tom Willemse ;; Keywords: local -;; Version: 2021.0708.235539 +;; Version: 2021.0715.222936 ;; Package-Requires: (oni-flycheck oni-lsp reformatter ccls) ;; This program is free software; you can redistribute it and/or modify @@ -22,7 +22,10 @@ ;;; Commentary: -;; C Configuration +;; C Configuration. Add the following to your init file in case you want to use +;; this configuration: +;; +;; (with-eval-after-load 'cc-mode (require 'oni-c)) ;;; Code: diff --git a/oni-circe.el b/oni-circe.el index fd28564..672dca0 100644 --- a/oni-circe.el +++ b/oni-circe.el @@ -4,7 +4,7 @@ ;; Author: Tom Willemse ;; Keywords: local -;; Version: 2021.0622.231018 +;; Version: 2021.0715.222837 ;; Package-Requires: (circe oni-lui circe-serenity) ;; This program is free software; you can redistribute it and/or modify @@ -22,7 +22,10 @@ ;;; Commentary: -;; Configuration for the Circe IRC client. +;; Configuration for the Circe IRC client. Add the following to your init file +;; in case you want to use this configuration: +;; +;; (with-eval-after-load 'circe (require 'oni-circe)) ;;; Code: diff --git a/oni-core.el b/oni-core.el index 81c61cd..bd3ce98 100644 --- a/oni-core.el +++ b/oni-core.el @@ -4,7 +4,7 @@ ;; Author: Tom Willemse ;; Keywords: local -;; Version: 2021.0707.100809 +;; Version: 2021.0715.222725 ;; Package-Requires: (oni-data-dir oni-embrace oni-hydra expand-region multiple-cursors gcmh diminish ws-butler which-key insert-char-preview dashboard) ;; This program is free software; you can redistribute it and/or modify @@ -23,7 +23,10 @@ ;;; Commentary: ;; Core Emacs configuration, doesn't need any requires from within -;; Emacs. These settings don't seem to go anywhere else. +;; Emacs. These settings don't seem to go anywhere else. Add the following to +;; your init file in case you want to use this configuration: +;; +;; (require 'oni-core) ;;; Code: diff --git a/oni-elfeed.el b/oni-elfeed.el index bedb0c9..5d86ad4 100644 --- a/oni-elfeed.el +++ b/oni-elfeed.el @@ -4,7 +4,7 @@ ;; Author: Tom Willemse ;; Keywords: local -;; Version: 2021.0701.175714 +;; Version: 2021.0715.222010 ;; Package-Requires: (elfeed olivetti) ;; This program is free software; you can redistribute it and/or modify @@ -22,7 +22,10 @@ ;;; Commentary: -;; Configuration for the elfeed feed reader. +;; Configuration for the elfeed feed reader. Add the following to your init file +;; in case you want to use this configuration: +;; +;; (with-eval-after-load 'elfeed (require 'oni-elfeed)) ;;; Code: diff --git a/oni-embrace.el b/oni-embrace.el index 40ef0fc..c361ab4 100644 --- a/oni-embrace.el +++ b/oni-embrace.el @@ -4,7 +4,7 @@ ;; Author: Tom Willemse ;; Keywords: local -;; Version: 2021.0621.231755 +;; Version: 2021.0715.221855 ;; Package-Requires: (embrace) ;; This program is free software; you can redistribute it and/or modify @@ -22,7 +22,10 @@ ;;; Commentary: -;; Configuration for embrace. +;; Configuration for embrace. Add the following to your init file in case you +;; want to use this configuration: +;; +;; (with-eval-after-load 'embrace (require 'oni-embrace)) ;;; Code: diff --git a/oni-flycheck.el b/oni-flycheck.el index 653ff14..7047b00 100644 --- a/oni-flycheck.el +++ b/oni-flycheck.el @@ -4,7 +4,7 @@ ;; Author: Tom Willemse ;; Keywords: local -;; Version: 2019.0904.210532 +;; Version: 2021.0715.221757 ;; Package-Requires: (flycheck flycheck-posframe flycheck-cask) ;; This program is free software; you can redistribute it and/or modify @@ -22,7 +22,10 @@ ;;; Commentary: -;; Configuration for flycheck. +;; Configuration for flycheck. Add the following to your init file in case you +;; want to use this configuration: +;; +;; (with-eval-after-load 'flycheck (require 'oni-flycheck)) ;;; Code: diff --git a/oni-hydra.el b/oni-hydra.el index 5b35bee..4151798 100644 --- a/oni-hydra.el +++ b/oni-hydra.el @@ -4,7 +4,7 @@ ;; Author: Tom Willemse ;; Keywords: local -;; Version: 2021.0621.231839 +;; Version: 2021.0715.221700 ;; Package-Requires: (hydra posframe) ;; This program is free software; you can redistribute it and/or modify @@ -23,6 +23,10 @@ ;;; Commentary: ;; Configuration for hydra. Set it up to use posframe instead of the default lv. +;; Add the following to your init file in case you want to use this +;; configuraiton: +;; +;; (with-eval-after-load 'hydra (require 'oni-hydra)) ;;; Code: diff --git a/oni-lsp.el b/oni-lsp.el index 6afb8a5..30b5882 100644 --- a/oni-lsp.el +++ b/oni-lsp.el @@ -4,7 +4,7 @@ ;; Author: Tom Willemse ;; Keywords: local -;; Version: 2020.1217.113334 +;; Version: 2021.0715.215836 ;; Package-Requires: (lsp-mode lsp-ui lsp-ivy) ;; This program is free software; you can redistribute it and/or modify @@ -22,7 +22,10 @@ ;;; Commentary: -;; Configuration for `lsp-mode' and friends. +;; Configuration for `lsp-mode' and friends. Add the following to your init file +;; in case you want to use this configuration: +;; +;; (with-eval-after-load 'lsp-mode (require 'oni-lsp)) ;;; Code: diff --git a/oni-lui.el b/oni-lui.el index f39e513..0bc41ff 100644 --- a/oni-lui.el +++ b/oni-lui.el @@ -4,7 +4,7 @@ ;; Author: Tom Willemse ;; Keywords: local -;; Version: 2021.0612.224938 +;; Version: 2021.0715.215705 ;; Package-Requires: (circe) ;; This program is free software; you can redistribute it and/or modify @@ -22,7 +22,10 @@ ;;; Commentary: -;; Configuration for the Linewise User Interface package. +;; Configuration for the Linewise User Interface package. Add the following to +;; you init file if you want to use this configuration: +;; +;; (with-eval-after-load 'lui (require 'oni-lui)) ;;; Code: diff --git a/oni-sh.el b/oni-sh.el index 54f5174..be2b2a3 100644 --- a/oni-sh.el +++ b/oni-sh.el @@ -4,7 +4,7 @@ ;; Author: Tom Willemse ;; Keywords: local -;; Version: 2021.0622.221353 +;; Version: 2021.0715.215613 ;; Package-Requires: (reformatter oni-flycheck oni-smartparens) ;; This program is free software; you can redistribute it and/or modify @@ -33,6 +33,10 @@ ;; It also defines a formatter using ‘reformatter’ which runs the shfmt utility. ;; This is set up to run after saving a shell script. +;; Add the following to your init file if you want to use this configuration: +;; +;; (with-eval-after-load 'sh-script (require 'oni-sh)) + ;;; Code: (require 'reformatter) diff --git a/oni-smartparens.el b/oni-smartparens.el index ed079e4..d568f3d 100644 --- a/oni-smartparens.el +++ b/oni-smartparens.el @@ -4,7 +4,7 @@ ;; Author: Tom Willemse ;; Keywords: local -;; Version: 2020.0114.220117 +;; Version: 2021.0715.215509 ;; Package-Requires: (smartparens) ;; This program is free software; you can redistribute it and/or modify @@ -22,7 +22,10 @@ ;;; Commentary: -;; Configuration for ‘smartparens-mode’. +;; Configuration for ‘smartparens-mode’. Add the following to your init file if +;; you want to use this configuration: +;; +;; (with-eval-after-load 'smartparens (require 'oni-smartparens)) ;;; Code: diff --git a/oni-vterm.el b/oni-vterm.el index d2f6d5a..d2b7314 100644 --- a/oni-vterm.el +++ b/oni-vterm.el @@ -4,7 +4,7 @@ ;; Author: Tom Willemse ;; Keywords: local -;; Version: 2021.0524.200055 +;; Version: 2021.0715.215412 ;; Package-Requires: (vterm) ;; This program is free software; you can redistribute it and/or modify @@ -22,7 +22,10 @@ ;;; Commentary: +;; My vterm configuration. Add the following to your init file if you want to +;; use this configuration: ;; +;; (with-eval-after-load 'vterm (require 'oni-vterm)) ;;; Code: diff --git a/oni-yasnippet.el b/oni-yasnippet.el index db50aaa..067df61 100644 --- a/oni-yasnippet.el +++ b/oni-yasnippet.el @@ -4,7 +4,7 @@ ;; Author: Tom Willemse ;; Keywords: local -;; Version: 2021.0630.150352 +;; Version: 2021.0715.212830 ;; Package-Requires: (yasnippet yasnippet-snippets diminish) ;; This program is free software; you can redistribute it and/or modify @@ -22,7 +22,12 @@ ;;; Commentary: -;; Yasnippet configuration. +;; Yasnippet configuration. To use this configuratin you should put the +;; following two lines in your init file: +;; +;; (with-eval-after-load 'yasnippet (require 'oni-yasnippet)) +;; (yas-global-mode) + ;;; Code: