Add package-level documentation

2 files changed, 10 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
diff --git a/factors/doc.go b/factors/doc.go
new file mode 100644
index 0000000..1b4dc02
--- /dev/null
+++ b/factors/doc.go
@@ -0,0 +1,5 @@
+/*
+The factors package contains all of the functions that compute the scores
+and ranks of radix_info, as well as all of the number theory behind them.
+*/
+package factors