added some doc files

snapp-incubator · Aug 28, 2023 · 201ffdf · 201ffdf
1 parent db5fc57
commit 201ffdf
Show file tree

Hide file tree

Showing 4 changed files with 1,003 additions and 0 deletions.
diff --git a/Makefile b/Makefile
@@ -279,3 +279,10 @@ catalog-build: opm ## Build a catalog image.
 .PHONY: catalog-push
 catalog-push: ## Push a catalog image.
 	$(MAKE) docker-push IMG=$(CATALOG_IMG)
+
+.PHONY: gen-doc
+gen-doc:
+	go install github.com/princjef/gomarkdoc/cmd/gomarkdoc@latest
+	mv README.md README.md.bck
+	~/go/bin/gomarkdoc --output '{{.Dir}}/README.md' ./...
+	mv README.md.bck README.md