Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Issue #25 #34

Closed
wants to merge 16 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
build:
strategy:
matrix:
go-version: [1.20.x]
go-version: [1.21.x]
os: [ubuntu-latest]
runs-on: ${{ matrix.os }}
steps:
Expand Down
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
.DS_Store

vendor
examples/*.svg

# Hiding the SVG output files introduces friction when adding a new TXT,SVG pair to the test suite.
# examples/*.svg

cmd/tmpl-expand/tmpl-expand
cmd/goat/goat
Expand Down
53 changes: 39 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

=> CONCLUSION: Don't use badges. Instead, pay attention to Action result status.
-->
<!-- ![](https://github.com/blampe/goat/actions/workflows/test.yml/badge.svg) -->
<!-- ![](https://github.com/dmullis/goat/actions/workflows/test.yml/badge.svg) -->

## What **GoAT** Can Do For You

Expand Down Expand Up @@ -58,7 +58,7 @@ with rows above and below.

## Installation
```
$ go install github.com/blampe/goat/cmd/goat@latest
$ go install github.com/dmullis/goat/cmd/goat@latest
```
<!-- https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections#creating-a-collapsed-section -->

Expand Down Expand Up @@ -176,14 +176,39 @@ Note that '·' above is not ASCII, but rather Unicode, the MIDDLE DOT character,

### Small Grids
```
___ ___ .---+---+---+---+---. .---+---+---+---. .---. .---.
___/ \___/ \ | | | | | | / \ / \ / \ / \ / | +---+ |
/ \___/ \___/ +---+---+---+---+---+ +---+---+---+---+ +---+ +---+
\___/ b \___/ \ | | | b | | | \ / \a/ \b/ \ / \ | +---+ |
/ a \___/ \___/ +---+---+---+---+---+ +---+---+---+---+ +---+ b +---+
\___/ \___/ \ | | a | | | | / \ / \ / \ / \ / | a +---+ |
\___/ \___/ '---+---+---+---+---' '---+---+---+---' '---' '---'

___ ___ .---+---+---+---+---. .---+---+---+---.
___/ \___/ \ | | | | | | / \ / \ / \ / \ /
/ \___/ \___/ +---+---+---+---+---+ +---+---+---+---+
\___/ b \___/ \ | | | b | | | \ / \a/ \b/ \ / \
/ a \___/ \___/ +---+---+---+---+---+ +---+---+---+---+
\___/ \___/ \ | | a | | | | / \ / \ / \ / \ /
\___/ \___/ '---+---+---+---+---' '---+---+---+---'

.---. .---. +--+ +-+ +-+ .-. .--. .-. +-+ +--+ .-. .--.
| | | | | | | | | | | | | | | | | | | | | | | |
+---+ +---+ +--+ +-+ | | | | | | | | +-+ +--+ '-' '--'
| +---+ | | | | | | | | | | | | |
+---+ b +---+ +--+ +-+ | | | | | | | |
| a +---+ | | | | | | | | | | | | |
'---' '---' +--+ +-+ +-+ '-' '--' '-'

+---+ .---. .---.
| B | | E | | F |
+---+ '---' '---'
.---. +---+ .---.
| D | | G | | H |
'---' +---+ '---'
0123456789012345678901232

Not Supported:
.---+---+---.
+---+ .-. .-. 0 | | a | | b |
| A | | A | | B | 1 +++ +--++-+-++--+
+---+ '-' '-' 2 | | | | | | |
+---+ .-. .-. 3 +-+ +--++-+-++--+
| C | | C | | D | 4 | | | | | |
+---+ '-' '-' 5 +++ '---+---+---'
0123434567890123456 |

```
![](//examples/small-grids.svg)
Expand Down Expand Up @@ -244,12 +269,12 @@ The core engine of ```goat``` is accessible as a Go library package, for inclusi
code of your own.
The code implements a subset, and some extensions, of the ASCII diagram generation function of the browser-side Javascript in [Markdeep](http://casual-effects.com/markdeep/).

A nicely formatted reference may be found at [pkg.go.dev](https://pkg.go.dev/github.com/blampe/goat).
A nicely formatted reference may be found at [pkg.go.dev](https://pkg.go.dev/github.com/dmullis/goat).

### Installation

```
$ go get -u github.com/blampe/goat/
$ go get -u github.com/dmullis/goat/
```
### Library Data Flow
![](//goat.svg)
Expand All @@ -261,13 +286,13 @@ source file [./goat.go](./goat.go).

<!--
XX XX May need a Github Action to do this substitution at "push" time.
[![resource non-responsive](https://pkg.go.dev/badge/github.com/blampe/goat)](https://pkg.go.dev/github.com/blampe/goat)
[![resource non-responsive](https://pkg.go.dev/badge/github.com/dmullis/goat)](https://pkg.go.dev/github.com/dmullis/goat)
-->

<!--
The scraping of GitHub by godocs.io (see https://sr.ht) does NOT include README.md;
whereas Google's pkg.go.dev does do so, and apparently runs its own variant of GFM processing :-/
[![resource non-responsive](https://godocs.io/github.com/blampe/goat?status.svg)](https://godocs.io/github.com/blampe/goat)
[![resource non-responsive](https://godocs.io/github.com/dmullis/goat?status.svg)](https://godocs.io/github.com/dmullis/goat)
-->

### Project Tenets
Expand Down
Loading
Loading