Browse Source

Edited README to include section on Documentation

SkylarHew 2 years ago
parent
commit
c8e911640e
1 changed files with 9 additions and 0 deletions
  1. 9 0
      README.md

+ 9 - 0
README.md

@@ -71,6 +71,15 @@ Additionally, Modpol seeks to counteract the tendency for "[implicit feudalism](
 
 It is certainly possible to use Modpol to replicate practices of implicit feudalism, such as all-powerful admins, but doing so requires extra work to overcome these defaults.
 
+## Documentation (LDoc)
+
+Documentation was generated using LDoc. To generate basic documentation for every page, use the following command.
+
+```
+/modpol/documentation$ ldoc ..
+```
+
+This will not generate the same index page and sidebar as the documentation provided.
 
 ## Credits