From 297bb6ac6e79a4134129c87d90f6f911b02dc9b4 Mon Sep 17 00:00:00 2001 From: Daniel Borchmann Date: Sun, 20 Sep 2020 14:48:59 +0200 Subject: [PATCH] Add short description of what db-projects is all about --- site-lisp/db-projects.el | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/site-lisp/db-projects.el b/site-lisp/db-projects.el index a0a0bc1..957029e 100644 --- a/site-lisp/db-projects.el +++ b/site-lisp/db-projects.el @@ -2,6 +2,18 @@ ;;; Commentary: +;; A project is simply a directory under `projects-main-project-directory' +;; containing either .git or .projectile. This little collection of functions +;; helps to manage these project directories and also integration them +;; consistently with the projectile package. + +;; To start, first customize `projects-main-project-directory' and +;; `projects-archive-directory' as needed. Then use `projects-add-project' to +;; add new projects and `projects-archive-project' to archive them (i.e., move +;; them to `projects-archive-directory'). This package does not offer to remove +;; projects; this has to be done manually. + +;; XXX: check known projects for missing bookmarks ;;; Code: