Skip to content

Commit 903b8b5

Browse files
added doc files for pkg.go.dev. (#68)
1 parent 9b00bd6 commit 903b8b5

File tree

2 files changed

+45
-0
lines changed

2 files changed

+45
-0
lines changed

doc.go

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
/*Package poly is a go package for engineering organisms.
2+
3+
4+
5+
Poly can be used in two ways.
6+
7+
1. As a Go library where you have finer control and can make magical things happen.
8+
2. As a command line utility where you can bash script your way to greatness and make DNA go brrrrrrrr.
9+
10+
11+
Installation
12+
13+
14+
These instructions assume that you already have a working go environment. If not see:
15+
https://golang.org/doc/install
16+
17+
18+
Building Poly CLI and package from scratch:
19+
20+
git clone https://github.com/TimothyStiles/poly.git && cd poly && go build ./... && go install ./...
21+
22+
23+
24+
Installing latest release of poly as a go package:
25+
go get github.com/TimothyStiles/poly
26+
27+
28+
For CLI only instructions please checkout: https://pkg.go.dev/github.com/TimothyStiles/poly/poly
29+
*/
30+
package poly

poly/doc.go

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
/*
2+
3+
Poly command line utility installation instructions:
4+
5+
Mac OSX
6+
7+
brew install timothystiles/poly/poly
8+
9+
Linux - deb/rpm
10+
Download the .deb or .rpm from the releases page https://github.com/TimothyStiles/poly/releases and install with `dpkg -i` and `rpm -i` respectively
11+
12+
Windows
13+
Coming soon...
14+
*/
15+
package main

0 commit comments

Comments
 (0)