summaryrefslogtreecommitdiff
path: root/doc.go
diff options
context:
space:
mode:
authorAdrien Hopkins <adrien.p.hopkins@gmail.com>2023-11-12 16:04:32 -0500
committerAdrien Hopkins <adrien.p.hopkins@gmail.com>2023-11-12 16:04:32 -0500
commit7ba8c6acc5dacfe693a3cb671fbbb58019cc0e1c (patch)
treedebdbe65f3e7de0182f62233de170aa5e14bb7ae /doc.go
parent35374b8ff8a480b5c9a16dd12a4770b66c83b16e (diff)
Add package-level documentation
Diffstat (limited to 'doc.go')
-rw-r--r--doc.go5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc.go b/doc.go
new file mode 100644
index 0000000..a1a778f
--- /dev/null
+++ b/doc.go
@@ -0,0 +1,5 @@
+/*
+The main package contains code that outputs the result of operations
+from the factors package.
+*/
+package main