added some explanation to the ldoc config file

EricCen · Aug 27, 2015 · 37b0dd4 · 37b0dd4
1 parent 558607c
commit 37b0dd4
Showing 1 changed file with 10 additions and 2 deletions.
diff --git a/config.ld b/config.ld
@@ -1,3 +1,13 @@
+-- LDoc configuration file
+-- See: https://github.com/stevedonovan/LDoc
+--
+-- LDoc installation;
+--    luarocks install ldoc
+--
+-- Generate the documentation from the Kong codebase;
+--    ldoc .
+--
+
 project='Kong'
 title='Kong by Mashape'
 description='Kong manages Microservices & APIs in a secure and extensible way'
@@ -9,5 +19,3 @@ sort=true
 sort_modules=true
 not_luadoc=true
 all=false
-
-