From a553a17a159f02ff1435de495bd55cded76d08d1 Mon Sep 17 00:00:00 2001
From: hi <hi>
Date: Tue, 12 Aug 2025 07:54:13 +0000
Subject: [PATCH] readme: verbose

---
 readme.md | 49 ++++++++++++++++++++++++++++++++++++++++---------
 1 file changed, 40 insertions(+), 9 deletions(-)

diff --git a/readme.md b/readme.md
index 0f0c19d..75776c0 100644
--- a/readme.md
+++ b/readme.md
@@ -1,31 +1,62 @@
 # statement logic !!!
 
-things you can do with this:
+things that are in here:
 
-### general things
+### general statement things
+
+#### [Logic/Statement/Parse.hs](Logic/Statement/Serialize.hs)
 
 - parse string -> statement
+- serialize a statement -> plaintext, LaTeX
+
+#### [Logic/Language/Impl/L.hs](Logic/Language/Impl/L.hs)
+
+- serialize a statement -> L (the formal language)
 - parse L (the formal language) string -> statement
-- serialize a statement to plaintext, LaTeX, L (the formal language)
 
 ### semantic things (statements have meaning I guess)
 
-- evaluate statements
-- from a statement generate a LaTeX truth table
+#### [Logic/Statement/Eval.hs](Logic/Statement/Eval.hs)
+
+- assign truth values and evaluate statements
+- determine tautology, contradiction, or contingent
+
+#### [Logic/Statement/Serialize.hs](Logic/Statement/Serialize.hs)
+
+- generate a LaTeX truth table from a statement
+
+#### [Logic/Statements/Laws.hs](Logic/Statements/Laws.hs)
+
 - match/replace patterns in statements (e.g. logical laws)
 - verify logical-law equivalence of statements (TODO)
-- find logical-law equivalence of statements with breadth-first search
+- find logical-law equivalence of statements with breadth-first search (slow)
 
 ### syntactic things (statements are strings of symbols)
 
-- implement formal languages (symbols, axioms schemas, and inference rules):
+#### [Logic/Language.hs](Logic/Language.hs)
+
+- implement formal languages (symbols, axioms schemas, and inference rules)
+  with a clunky api, see also
   <https://en.wikipedia.org/wiki/Post_canonical_system>
+
+### [Logic/Language/Derivation.hs](Logic/Language/Derivation.hs)
+
 - verify derivations in formal languages
 
 ### formal languages implemented
 
-- the MIU system (from "Gödel, Escher, Bach")
-- L
+- [the MIU system](Logic/Language/Impl/MIU.hs) (from "Gödel, Escher, Bach")
+- [L](Logic/Language/Impl/L.hs)
+
+### general things
+
+#### [Logic/Parse.hs](Logic/Parse.hs)
+
+- generic sequence parser
+
+#### [Logic/Graph.hs](Logic/Graph.hs)
+
+- generic breadth-first search
 
 ## requirements