Skip to content

Commit

Permalink
Prepare for publish
Browse files Browse the repository at this point in the history
* README.txt: Move changelog to the bottom.
* vundo.el: Add copyright, etc, Set to version 1.0.0. Copy over some
README to Commentary.
  • Loading branch information
casouri committed Apr 4, 2022
1 parent 9edd0ca commit 0e3af84
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 11 deletions.
21 changes: 12 additions & 9 deletions README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,20 @@ to run those tests interactively, or use the following batch command:
-l test/vundo-test.el \
-f ert-run-tests-batch-and-exit

Comparing to undo-tree:

Vundo doesn’t need to be turned on all the time nor replace the undo
commands like undo-tree does. Vundo displays the tree horizontally,
whereas undo-tree displays a tree vertically. Vundo doesn’t have many
advanced features that undo-tree does (like showing diff), and most
probably will not add those features in the future.



Changelog:

<2022-04-04 Mon> Version 1.0.0

<2022-03-29 Tue> vundo--mode and vundo--mode-map are now vundo-mode
and vundo-mode-map. A new custom option vundo-compact-display is added.

Expand All @@ -70,12 +82,3 @@ differently now, it now draws

<2021-11-26 Fri>: Variable vundo-translate-alist changed to
vundo-glyph-alist and has different value now.


Comparing to undo-tree:

Vundo doesn’t need to be turned on all the time nor replace the undo
commands like undo-tree does. Vundo displays the tree horizontally,
whereas undo-tree displays a tree vertically. Vundo doesn’t have many
advanced features that undo-tree does (like showing diff), and most
probably will not add those features in the future.
49 changes: 47 additions & 2 deletions vundo.el
Original file line number Diff line number Diff line change
@@ -1,9 +1,28 @@
;;; vundo.el --- Visual undo tree -*- lexical-binding: t; -*-

;; Copyright (C) 2019-2020 Free Software Foundation, Inc.
;;
;; Author: Yuan Fu <[email protected]>
;; Maintainer: Yuan Fu <[email protected]>
;; URL: https://github.com/casouri/vundo
;; Version: 1.0.0
;; Keywords: undo, text
;; Package-Requires: ((emacs "28.0"))

;;; This file is NOT part of GNU Emacs
;;
;; This file is part of GNU Emacs.
;;
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;;
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;;
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.

;;; Commentary:
;;
Expand All @@ -25,6 +44,32 @@
;; original buffer, the tree in the vundo buffer doesn’t automatically
;; update. Vundo catches up the next time you invoke any command:
;; instead of performing that command, it updates the tree.
;;
;; Faces:
;;
;; - vundo-default
;; - vundo-node
;; - vundo-stem
;; - vundo-highlight
;;
;; If you want to use prettier Unicode characters to draw the tree like
;; this:
;;
;; ○──○──○
;; │ └──●
;; ├──○
;; └──○
;;
;; set vundo-glyph-alist by
;;
;; (setq vundo-glyph-alist vundo-unicode-symbols)
;;
;; Your default font needs to contain these Unicode characters, otherwise
;; they look terrible and don’t align. You can find a font that covers
;; these characters (eg, Symbola, Unifont), and set ‘vundo-default’ face
;; to use that font:
;;
;; (set-face-attribute 'vundo-default nil :family "Symbola")

;;; Developer:
;;
Expand Down

0 comments on commit 0e3af84

Please sign in to comment.