aboutsummaryrefslogtreecommitdiff
path: root/sucl/new.icl
diff options
context:
space:
mode:
Diffstat (limited to 'sucl/new.icl')
-rw-r--r--sucl/new.icl46
1 files changed, 46 insertions, 0 deletions
diff --git a/sucl/new.icl b/sucl/new.icl
new file mode 100644
index 0000000..0531019
--- /dev/null
+++ b/sucl/new.icl
@@ -0,0 +1,46 @@
+new.lit - One line module description
+=====================================
+
+Description
+-----------
+
+Describe in a few paragraphs what this module defines.
+
+------------------------------------------------------------------------
+
+Interface
+---------
+
+Exported identifiers:
+
+> %export
+> identifier || One line description
+> ...
+
+Required types:
+
+ identifier - type@source.lit type@source.lit
+ ...
+
+------------------------------------------------------------------------
+
+Includes
+--------
+
+> %include "source.lit" || identifier ...
+> ...
+
+------------------------------------------------------------------------
+
+Implementation
+--------------
+
+Implementation of identifier
+
+> identifier
+> :: type
+
+> identifierone arguments
+> = body
+
+...