Merge pull request #3999 from daijingz/CP3

#2857 out-of-date README.md Update 5
JacquesCarette · Jan 3, 2025 · 5664fc3 · 5664fc3
2 parents dd4d697 + 05e7688
commit 5664fc3
Show file tree

Hide file tree

Showing 6 changed files with 31 additions and 7 deletions.
diff --git a/code/drasil-printers/lib/Language/Drasil/Printing/README.md b/code/drasil-printers/lib/Language/Drasil/Printing/README.md
@@ -1,8 +1,11 @@
 ----------------------------------------------------------
 ### Quick Summary of Folder Structure and File Contents
-Last updated: July 20, 2018
+Last updated: December 31, 2024
 ----------------------------------------------------------
 
+**Import**
+  - Defines necessary external functions for layout AST.
+
 AST.hs
   - Layout AST used for both HTML and TeX.
 
@@ -19,5 +22,8 @@ Import.hs
 LayoutObj.hs
   - The layout AST version of layout objects. Similar to the Drasil layout objects.
 
+PrintingInformation.hs
+  - Defines types and functions to gather all the information needed for printing.
+
 README.md
   - This file.
diff --git a/code/drasil-printers/lib/Language/Drasil/TeX/README.md b/code/drasil-printers/lib/Language/Drasil/TeX/README.md
@@ -10,10 +10,10 @@ Monad.hs
   - Maintains the printing context (text vs math mode).
 
 Preamble.hs
-  - Generates the TeX preamble based on the necessary packages for a doc
+  - Generates the TeX preamble based on the necessary packages for a doc.
 
 Print.hs
-  - Defines the pretty printer for generating the LaTeX documents from the AST representation
+  - Defines the pretty printer for generating the LaTeX documents from the AST representation.
 
 README.md
   - This file.
diff --git a/code/drasil-theory/lib/README.md b/code/drasil-theory/lib/README.md
@@ -8,3 +8,6 @@ Last updated: Sept. 15, 2021
 
 **Theory**
   - Contains the theory for the Drasil language
+
+README.md
+  - This file
diff --git a/code/drasil-theory/lib/Theory/Drasil/README.md b/code/drasil-theory/lib/Theory/Drasil/README.md
@@ -1,8 +1,14 @@
 --------------------------------------------------
 ### Summary of Folder Structure and File Contents
-Last updated: May 15, 2019
+Last updated: December 31, 2024
 --------------------------------------------------
 
+Classes.hs
+  - Defining all the classes which represent knowledge-about-theories
+
+ConstraintSet.hs
+  - Defines types used in models and theories
+
 DataDefinition.hs
   - Defines DataDefinition data type and constructors
 
@@ -12,6 +18,12 @@ GenDefn.hs
 InstanceModel.hs
   - Instance model chunks
 
+ModelKinds.hs
+  - Defines types and functions for creating models
+
+MultiDefn.hs
+  - Defines types and functions for creating mult-definitions
+
 README.md
   - This file
 

diff --git a/code/drasil-utils/README.md b/code/drasil-utils/README.md
@@ -5,15 +5,15 @@ Last updated: Sept. 15, 2021
 
 **lib**
   - Contains the library code for this package.
-
-README.md
-  - This file
 
 drasil-utils.cabal
   - Cabal file, used by stack to build drasil-utils. This file is generated by the `package.yaml` file and should not be manually changed.
 
 package.yaml
   - This file is used by hpack to generate the `drasil-utils.cabal` and can be changed manually.
 
+README.md
+  - This file
+
 stack.yaml
   - Autogenerated file used by Stack. Any extra dependencies may need to be listed here.
diff --git a/code/drasil-utils/lib/README.md b/code/drasil-utils/lib/README.md
@@ -5,3 +5,6 @@ Last updated: Sept. 15, 2021
 
 **Utils**
   - Contains various utilities used in Drasil.
+
+README.md
+  - This file