Add documentation for all the exported symbols

[candle] / src / main / package.lisp

diff --git a/src/main/package.lisp b/src/main/package.lisp
index 7545b28cead83e38cceb16675915a9b1cc4f0339..63654509575bc4a0e6cab3d6551add1616db80dd 100644 (file)
--- a/src/main/package.lisp
+++ b/src/main/package.lisp
@@ -5,7 +5,12 @@
   #:project-job-information #:get-job-log #:retry-job #:job-project #:project-dir #:process-job-in-system
   #:shutdown-system
 
-  #:candle-error #:candle-error-reason))
+  #:candle-error #:candle-error-reason)
+ (:documentation "Main candle package.
+
+Candle is continuous integration server and command line utility for common
+lisp projects.  The package is mainly accessed through the command line
+scripts in the bin directory."))
 
 (defpackage #:candle-cli (:use :cl) (:export :run))
 (defpackage #:candle-server-cli (:use :cl) (:export :run))