[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/why-this 066786ede1 17/59: Add README
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/why-this 066786ede1 17/59: Add README |
Date: |
Sun, 27 Nov 2022 16:02:50 -0500 (EST) |
branch: elpa/why-this
commit 066786ede16a9d6d70e2e7aded6235b28747a39b
Author: Akib Azmain Turja <akib@disroot.org>
Commit: Akib Azmain Turja <akib@disroot.org>
Add README
---
README.org | 62 ++++++++++++++++++++++++++++++++++++++++++++++++
images/annotate.png | Bin 0 -> 186118 bytes
images/blame-region.png | Bin 0 -> 182406 bytes
images/blame.png | Bin 0 -> 136015 bytes
4 files changed, 62 insertions(+)
diff --git a/README.org b/README.org
new file mode 100644
index 0000000000..28863c031c
--- /dev/null
+++ b/README.org
@@ -0,0 +1,62 @@
+#+title: why-this - Why the current line contains this?
+
+~why-this~ shows why the current line was changed on the right side of
+line. It can also show editing history with heat map.
+
+* Screenshots
+
+#+caption: why-this-mode
+[[./images/blame.png]]
+Blame on the right side of current line.
+
+#+caption: why-this-mode with region activated
+[[./images/blame-region.png]]
+Blame on the right side of each line in region.
+
+#+caption: why-this-annotate with heat map
+[[./images/annotate.png]]
+Editing history with heat map.
+
+* Install
+
+** straight.el
+
+#+begin_src emacs-lisp
+(straight-use-package
+ '(why-this :type git
+ :repo "https://codeberg.org/akib/emacs-why-this.git"))
+#+end_src
+
+* Usage
+
+Type =M-x why-this-mode= to enable showing blame.
+
+Type =M-x why-this= to show blame on echo area.
+
+Type =M-x why-this-annotate= to show editing history on a dedicated buffer.
+
+* Configuration
+
+Put the following in your init file to enable ~why-this-mode~ in every
+possible buffer:
+
+#+begin_src emacs-lisp
+(global-why-this-mode)
+#+end_src
+
+Output by ~why-this-annotate~ may be hard to read depending on the theme.
+Put the following in your init file to change the colors:
+
+- For dark theme users:
+
+ #+begin_src emacs-lisp
+ (setq why-this-annotate-heat-map-cold "#203448")
+ (setq why-this-annotate-heat-map-warm "#382f27")
+ #+end_src
+
+- For light theme users:
+
+ #+begin_src emacs-lisp
+ (setq why-this-annotate-heat-map-cold "#dde3f4")
+ (setq why-this-annotate-heat-map-warm "#f0e0d4")
+ #+end_src
diff --git a/images/annotate.png b/images/annotate.png
new file mode 100644
index 0000000000..2edda01d7d
Binary files /dev/null and b/images/annotate.png differ
diff --git a/images/blame-region.png b/images/blame-region.png
new file mode 100644
index 0000000000..abd2663631
Binary files /dev/null and b/images/blame-region.png differ
diff --git a/images/blame.png b/images/blame.png
new file mode 100644
index 0000000000..c1693824aa
Binary files /dev/null and b/images/blame.png differ
- [nongnu] elpa/why-this c7f771736c 44/59: Remove obsolete use of define-minor-mode, (continued)
- [nongnu] elpa/why-this c7f771736c 44/59: Remove obsolete use of define-minor-mode, ELPA Syncer, 2022/11/27
- [nongnu] elpa/why-this 2c8c35ca10 57/59: Bump version to 2.0.3, ELPA Syncer, 2022/11/27
- [nongnu] elpa/why-this 258f010001 54/59: Bump version to 2.0.2, ELPA Syncer, 2022/11/27
- [nongnu] elpa/why-this 0975f5b57f 48/59: Fix #2: Truncate long lines in annotation buffer, ELPA Syncer, 2022/11/27
- [nongnu] elpa/why-this da0fa6da7e 52/59: Bump version to 2.0.1, ELPA Syncer, 2022/11/27
- [nongnu] elpa/why-this f0ef9e3730 51/59: Show overlay only on selected window, ELPA Syncer, 2022/11/27
- [nongnu] elpa/why-this f18b8d8d18 43/59: Lower required Emacs version, ELPA Syncer, 2022/11/27
- [nongnu] elpa/why-this c5d192cfee 56/59: Some cleanup, ELPA Syncer, 2022/11/27
- [nongnu] elpa/why-this 4552587fd4 49/59: Determine line width correctly, ELPA Syncer, 2022/11/27
- [nongnu] elpa/why-this ca4cf46d6e 40/59: Don't error on nonexistant parent directory, ELPA Syncer, 2022/11/27
- [nongnu] elpa/why-this 066786ede1 17/59: Add README,
ELPA Syncer <=
- [nongnu] elpa/why-this a4e7a1a126 47/59: Bump version to 2.0, ELPA Syncer, 2022/11/27
- [nongnu] elpa/why-this 71baf80f9a 42/59: Don't use overlays while annonating, ELPA Syncer, 2022/11/27
- [nongnu] elpa/why-this a706d26b7c 45/59: Fix wrong face in annonate buffer, ELPA Syncer, 2022/11/27
- [nongnu] elpa/why-this b69263c66b 41/59: Fix "Invalid face attribute :background nil", ELPA Syncer, 2022/11/27