branch: elpa/sesman commit a39f0e2c1ba6caf81087bdff2d876c63438b0a90 Author: Vitalie Spinu <spinu...@gmail.com> Commit: Vitalie Spinu <spinu...@gmail.com>
Add commentary --- README.md | 10 ++++------ sesman.el | 6 +++++- 2 files changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 56b67c64fa..108faff876 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,13 @@ [![License GPL 3][badge-license]](http://www.gnu.org/licenses/gpl-3.0.txt) [](http://melpa.org/#/sesman) [](http://stable.melpa.org/#/sesman) -[](https://travis-ci.org/vspinu/sesman) +[](https://travis-ci.org/vspinu/sesman) -## Generic session manager for Emacs +## Generic Session Manager for Emacs -This is a brief overview. Please see the code for more details. +Sesman provides facilities for session management and interactive session association with the current contexts (e.g. project, directory, buffers). While sesman can be used to manage arbitrary "sessions", it primary targets the Emacs based IDEs ([CIDER][], [ESS][], [Geiser][], [Robe][], [SLIME][] etc.) -Sesman provides facilities for session management and interactive session association with current contexts. While "sessions" is a broad and implementation specific concept, the primary target of `sesman` are Emacs based IDEs ([CIDER][], [ESS][], [Geiser][], [Robe][], [SLIME][] etc.) - -For Emacs based IDEs, session is commonly composed of one or more physical processes (sub-processes, sockets, websockets etc). For example in the current implementation of [CIDER][] a session would be composed of one or more sesman connections (Clojre or ClojureScript). Each [CIDER][] connection consists of user REPL buffer and two sub-processes, one for user eval communication and another for tooling (completion, inspector etc). +For Emacs based IDEs, session are commonly composed of one or more physical processes (sub-processes, sockets, websockets etc). For example in the current implementation of [CIDER][] a session would be composed of one or more sesman connections (Clojre or ClojureScript). Each [CIDER][] connection consists of user REPL buffer and two sub-processes, one for user eval communication and another for tooling (completion, inspector etc). ### Concepts: diff --git a/sesman.el b/sesman.el index af6482a528..d524cc6b62 100644 --- a/sesman.el +++ b/sesman.el @@ -1,4 +1,4 @@ -;;; sesman.el --- Session and connection manager interface -*- lexical-binding: t -*- +;;; sesman.el --- Generic Session Manager for Emacs -*- lexical-binding: t -*- ;; ;; Copyright (C) 2018, Vitalie Spinu ;; Author: Vitalie Spinu @@ -29,6 +29,10 @@ ;; ;;; Commentary: ;; +;; Sesman provides facilities for session management and interactive session +;; association with the current contexts (project, directory, buffers etc). See +;; project's readme for more details. +;; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; ;;; Code: