From 926242710b9a4f78db0f824d12a32536ceff4987 Mon Sep 17 00:00:00 2001
From: Jeff Carr <jcarr@wit.com>
Date: Mon, 5 Feb 2024 12:24:32 -0600
Subject: [PATCH] docs

Signed-off-by: Jeff Carr <jcarr@wit.com>
---
 Makefile  |  6 ++++++
 README.md | 41 ++++++++++++++++++++++++++++++++++++++++-
 main.go   |  1 -
 3 files changed, 46 insertions(+), 2 deletions(-)

diff --git a/Makefile b/Makefile
index ebef5dc..efe3e38 100644
--- a/Makefile
+++ b/Makefile
@@ -9,6 +9,12 @@ build: nocui gocui andlabs
 goimports:
 	goimports -w *.go
 
+# Test the README.md & doc.go file
+# this runs pkgsite, the binary that does dev.go.dev
+# go install golang.org/x/pkgsite/cmd/pkgsite@latest
+pkgsite:
+	GO111MODULE= pkgsite
+
 redomod:
 	rm -f go.*
 	GO111MODULE= go mod init
diff --git a/README.md b/README.md
index 6392120..b65418b 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,40 @@
-# makes a debian package of the toolkits
+# The create GUI toolkit packages for debian
+
+This package will create a .deb package of the GUI toolkits.
+
+![Debian image](https://www.debian.org/logos/openlogo.svg)
+*[Debian logo][rf], licensed under [Creative Commons 3.0 Attributions license][cc3-by].*
+
+Our canonical Git repository is located at https://git.wit.org/toolkits/debian
+
+The package source files are distributed under the various licenses. Some are proprietary
+because the underlying OS is proprietary. Whenever possible, the Linux ones are GPL.
+
+### Download and Install
+
+#### Binary Distributions
+
+Official binary distributions are available at TODO: finish this
+
+#### Install From Source
+
+To download the toolkit packages:
+
+```go
+    go get -v go.wit.com/toolkits/debian
+    cd ~/go/src/toolkits/debian
+    make
+```
+To build the debian package
+```go
+    go get -v go.wit.com/toolkits/debian
+    cd ~/go/src/toolkits/debian
+    make debian
+```
+
+### Contributing
+
+To contribute, please refer to [go.wit.com](http://go.wit.com)
+
+[rf]: https://debian.org/
+[cc3-by]: https://creativecommons.org/licenses/by/3.0/
diff --git a/main.go b/main.go
index 0cb35d9..9865f61 100644
--- a/main.go
+++ b/main.go
@@ -1,4 +1,3 @@
-// make a simple app to build everything
 package main
 
 import 	(