[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] master f1d397c 1/5: Improve README.md and add a screenshot

From: João Távora
Subject: [elpa] master f1d397c 1/5: Improve README.md and add a screenshot
Date: Fri, 15 Mar 2019 18:35:46 -0400 (EDT)

branch: master
commit f1d397c92f99041b9f000e26e6430680b5195939
Author: João Távora <address@hidden>
Commit: João Távora <address@hidden>

    Improve README.md and add a screenshot
 README         |   0
 README.md      |  32 ++++++++++++++++++++++++++++++++
 screenshot.png | Bin 0 -> 160486 bytes
 3 files changed, 32 insertions(+)

diff --git a/README b/README
deleted file mode 100644
index e69de29..0000000
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..013709d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+Remove visual distractions and focus on writing.
+This extension is available on Emacs' own GNU ELPA. Alternatively, put
+`darkroom.el` somewhere in your load-path and `require` it.
+The main entrypoints are two minor modes:
+* `M-x darkroom-mode`
+  `darkroom-mode` makes visual distractions disappear: the mode-line is
+  temporarily elided, text is enlarged and margins are adjusted so that
+  text centered on the window.
+* `M-x darkroom-tentative-mode`
+  `darkroom-tentative-mode` is similar, but it only turns on these
+  features if the current buffer occupies the sole window of the
+  Emacs frame (i.e. all other windows are deleted). Whenever the
+  frame is split to display more windows and more buffers, the buffer
+  exits `darkroom-mode`. Whenever they are deleted, the buffer
+  re-enters `darkroom-mode`.
+Personally, I always use `darkroom-tentative-mode`.
+See also the customization options `darkroom-margins` and
+`darkroom-fringes-outside-margins`, which affect both modes.
diff --git a/screenshot.png b/screenshot.png
new file mode 100644
index 0000000..c8aacbf
Binary files /dev/null and b/screenshot.png differ

reply via email to

[Prev in Thread] Current Thread [Next in Thread]