[elpa] externals-release/activities ab283c95ad 038/103: Update: Readme, commentary

[ELPA Syncer]

branch: externals-release/activities
commit ab283c95ad68be26fd67ec5d8bc195149f533506
Author: Adam Porter <adam@alphapapa.net>
Commit: Adam Porter <adam@alphapapa.net>

    Update: Readme, commentary
---
 README.org  | 15 +++++++++++++++
 activity.el |  5 +++++
 2 files changed, 20 insertions(+)

diff --git a/README.org b/README.org
index 91fe1d1afe..0fd5cea6d3 100644
--- a/README.org
+++ b/README.org
@@ -8,6 +8,16 @@ Integration with Emacs's ~tab-bar-mode~ is provided: a window 
configuration or f
 
 Various hooks are (or will be--feedback is welcome) provided, both globally 
and per-activity, so that the user can define functions to be called when an 
activity is saved, restored, or switched from/to.  For example, this could be 
used to limit the set of buffers offered for switching to within an activity, 
or to track the time spent in an activity.
 
+* Contents
+:PROPERTIES:
+:TOC:      :include siblings :depth 0 :force (nothing) :ignore (this) :local 
(nothing)
+:END:
+:CONTENTS:
+- [[#installation][Installation]]
+- [[#usage][Usage]]
+- [[#faq][FAQ]]
+:END:
+
 * Installation
 
 Until this library is available from a package archive, it's recommended to 
install it using [[https://framagit.org/steckerhalter/quelpa][Quelpa]]:
@@ -42,6 +52,11 @@ If you choose to install it otherwise, you'll need to load 
both the ~activity~ a
 
 * Usage
 
+** Modes
+
++ ~activity-mode~ :: Automatically saves activities' states when Emacs is 
idle.  Should be enabled while using this package (otherwise you would have to 
manually call ~activity-save-all~, which would defeat much of the purpose of 
this library).
++ ~activity-tabs-mode~ :: Causes activities to be managed as ~tab-bar~ tabs 
rather than frames (the default).  (/This is what the author uses; bugs present 
when this mode is not enabled are less likely to be found, so please report 
them./)
+
 ** Workflow
 
 1. Arrange windows in a tab according to an activity you're performing.
diff --git a/activity.el b/activity.el
index 149df1bcd9..2ffd60f506 100644
--- a/activity.el
+++ b/activity.el
@@ -20,6 +20,11 @@
 ;; You should have received a copy of the GNU General Public License
 ;; along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
+;;; Acknowledgments:
+
+;; Thanks to Pat Metheny, whose music aided the initial
+;; implementation.
+
 ;;; Commentary:
 
 ;; Inspired by Genera's and KDE's concepts of "activities", this