branch: elpa/casual
commit 5501e56016aebda49fa7f4ee55d61b24a67ed90d
Merge: 3f09c8c4c4 1391f52477
Author: Charles Choi <[email protected]>
Commit: GitHub <[email protected]>
Merge pull request #51 from kickingvegas/50-update-screenshots-and-copy
Update screenshots and copy
---
README.org | 4 +++-
docs/images/casual-isearch-tmenu.png | Bin 403315 -> 388019 bytes
lisp/casual.el | 38 ++++++++++++++++++++++++++++++-----
3 files changed, 36 insertions(+), 6 deletions(-)
diff --git a/README.org b/README.org
index a5aff5dd75..528f1a7a0b 100644
--- a/README.org
+++ b/README.org
@@ -97,12 +97,14 @@ If you have been using an earlier version 1.x of Casual,
thank you. Please use t
*** If you do not use ~use-package~ to configure Casual
Before installing Casual, you should update all of your existing Casual
packages. This is most easily done via the
[[https://www.gnu.org/software/emacs/manual/html_node/emacs/Package-Menu.html][package
menu buffer]]. After updating your packages, install the ~casual~ package.
+Migrate your existing Casual packages from 1.x to 2.x by running the following
commands:
+
#+BEGIN_SRC elisp
M-x load-library casual
M-x casual-upgrade-base-to-version-2
#+END_SRC
-This command will uninstall any Casual v1.x packages that have been superseded
by this package.
+Any Casual v1.x packages that have been superseded by this package will be
uninstalled.
While not necessary, it is recommended to run ~M-x package-autoremove~ to
purge any dangling dependent packages. Cautious readers can choose to audit any
packages that are targeted to be removed.
diff --git a/docs/images/casual-isearch-tmenu.png
b/docs/images/casual-isearch-tmenu.png
index 3e313a229d..92c7746265 100644
Binary files a/docs/images/casual-isearch-tmenu.png and
b/docs/images/casual-isearch-tmenu.png differ
diff --git a/lisp/casual.el b/lisp/casual.el
index f509bf8025..520325104b 100644
--- a/lisp/casual.el
+++ b/lisp/casual.el
@@ -72,14 +72,42 @@
;; UPGRADING to Casual 2.x
-;; If you have installed any Casual package that is version 1.x, you should
-;; immediately run the following commands upon installation of casual.
+;; If you have been using an earlier version 1.x of Casual, thank you. Please
+;; use the following guidance:
-;; M-x load-libary casual
+;; * If you do not use `use-package' to configure Casual
+
+;; Before installing Casual, you should update all of your existing Casual
+;; packages. This is most easily done via the package menu buffer described in
+;; info node `(emacs) Package Menu'. After updating your packages, install the
+;; `casual' package.
+
+;; Migrate your existing Casual packages from 1.x to 2.x by running the
+;; following commands:
+
+;; M-x load-library casual
;; M-x casual-upgrade-base-to-version-2
-;; This command will uninstall any Casual v1.x packages that have been
-;; superseded by this package.
+;; Any Casual v1.x packages that have been superseded by this package will be
+;; uninstalled.
+
+;; While not necessary, it is recommended to run `package-autoremove' to purge
+;; any dangling dependent packages. Cautious readers can choose to audit any
+;; packages that are targeted to be removed.
+
+;; * If you have used `use-package' to configure Casual
+
+;; For version 2.x going forward, I (Charles Choi) have decided to not offer
any
+;; documented guidance on using `use-package' to configure Casual due my lack
of
+;; expertise in using it. I leave it to more skilled readers to determine how
to
+;; best use it (described in info node `(use-package) Top') for their
+;; configuration. Please also note that this is not a prohibition on using
+;; `use-package' with Casual. I am simply admitting that I don't know how to
use
+;; it.
+
+;; That said, if you have used :ensure t to install a superseded package, you
+;; must remove that configuration. After doing so, please follow the above
+;; instructions for installing `casual'.
;; If you are using Emacs ≤ 30.0, you will need to update the built-in package
;; `transient'. By default, `package.el' will not upgrade a built-in package.
