Add Licensing and Contributing

[candle] / src / main / base.lisp

diff --git a/src/main/base.lisp b/src/main/base.lisp
index 793841a00bd19ebc2e654bb3b3f5400e04967252..09f90035c439d7e4182f6cae8dfb02a24789fbfd 100644 (file)
--- a/src/main/base.lisp
+++ b/src/main/base.lisp
@@ -1,3 +1,4 @@
+; Copyright 2022 Frank Duncan (frank@consxy.com) under AGPL3.  See distributed LICENSE.txt.
 (in-package #:candle)
 
 (defvar *candle-dir* nil
@@ -89,6 +90,18 @@ DESCRIPTION:
 ; this will get set to nil but we keep them around for historical reference
 (lame-db:defdbstruct branch name in-git (project :join project) (job :join job))
 
+(setf (documentation 'project-name 'function)
+ "PROJECT-NAME PROJECT => NAME
+
+ARGUMENTS AND VALUES:
+
+  PROJECT: the project
+  NAME: a string, the name of the job
+
+DESCRIPTION:
+
+  Returns the name of the project in question.")
+
 (defun project-dir (project)
  "PROJECT-DIR PROJECT => DIR