added doc files for pkg.go.dev. (#68)

bebop · Nov 2, 2020 · 903b8b5 · 903b8b5
1 parent 9b00bd6
commit 903b8b5
Show file tree

Hide file tree

Showing 2 changed files with 45 additions and 0 deletions.
diff --git a/doc.go b/doc.go
@@ -0,0 +1,30 @@
+/*Package poly is a go package for engineering organisms.
+
+
+
+Poly can be used in two ways.
+
+	 1. As a Go library where you have finer control and can make magical things happen.
+	 2. As a command line utility where you can bash script your way to greatness and make DNA go brrrrrrrr.
+
+
+Installation
+
+
+These instructions assume that you already have a working go environment. If not see:
+	https://golang.org/doc/install
+
+
+Building Poly CLI and package from scratch:
+
+	git clone https://github.com/TimothyStiles/poly.git && cd poly && go build ./... && go install ./...
+
+
+
+Installing latest release of poly as a go package:
+	go get github.com/TimothyStiles/poly
+
+
+For CLI only instructions please checkout: https://pkg.go.dev/github.com/TimothyStiles/poly/poly
+*/
+package poly
diff --git a/poly/doc.go b/poly/doc.go
@@ -0,0 +1,15 @@
+/*
+
+Poly command line utility installation instructions:
+
+Mac OSX
+
+	brew install timothystiles/poly/poly
+
+Linux - deb/rpm
+	Download the .deb or .rpm from the releases page https://github.com/TimothyStiles/poly/releases and install with `dpkg -i` and `rpm -i` respectively
+
+Windows
+	Coming soon...
+*/
+package main