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.

Sign up for GitHub

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

Jump to bottom

For blampe 7.3.2 #37

Merged
merged 2 commits into from
Jul 31, 2024
Merged

For blampe 7.3.2 #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a5193b9
Fix wrong download paths and file reference in README.md
Jul 31, 2024
969d61f
Fix display of SVG output examples in README.md
Jul 31, 2024
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
36 changes: 18 additions & 18 deletions README.md
View file
Open in desktop
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/dmullis/goat/actions/workflows/test.yml/badge.svg) -->
<!-- ![](https://github.com/blampe/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/dmullis/goat/cmd/goat@latest
$ go install github.com/blampe/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 @@ -87,7 +87,7 @@ GoAT's [README.md](README.md), then finally rendered to HTML ```<img>``` element


```
![](//examples/trees.svg)
![](/examples/trees.svg)

### Trees -- mid-range color value
Setting a foreground color in the middle of the possible range of value or luminance
Expand All @@ -99,7 +99,7 @@ CSS property by
from within an enclosing `<img>` element such as are generated by Markdown.


![](//trees.mid-blue.svg)
![](/trees.mid-blue.svg)

### Overlaps
```
Expand All @@ -113,7 +113,7 @@ from within an enclosing `<img>` element such as are generated by Markdown.
'-' '-' '-' '-' '-' '-'

```
![](//examples/overlaps.svg)
![](/examples/overlaps.svg)

### Line Decorations
```
Expand All @@ -126,7 +126,7 @@ from within an enclosing `<img>` element such as are generated by Markdown.
/\ *---------------'

```
![](//examples/line-decorations.svg)
![](/examples/line-decorations.svg)

### Line Ends
```
Expand All @@ -143,7 +143,7 @@ from within an enclosing `<img>` element such as are generated by Markdown.


```
![](//examples/line-ends.svg)
![](/examples/line-ends.svg)

### Dot Grids
```
Expand All @@ -157,7 +157,7 @@ from within an enclosing `<img>` element such as are generated by Markdown.

```
Note that '·' above is not ASCII, but rather Unicode, the MIDDLE DOT character, encoded with UTF-8.
![](//examples/dot-grids.svg)
![](/examples/dot-grids.svg)

### Large Nodes
```
Expand All @@ -172,7 +172,7 @@ Note that '·' above is not ASCII, but rather Unicode, the MIDDLE DOT character,
'-' '---' '-' '---' '-' '-' '---'

```
![](//examples/large-nodes.svg)
![](/examples/large-nodes.svg)

### Small Grids
```
Expand Down Expand Up @@ -211,7 +211,7 @@ Not Supported:
0123434567890123456 |

```
![](//examples/small-grids.svg)
![](/examples/small-grids.svg)

### Big Grids
```
Expand All @@ -229,7 +229,7 @@ Not Supported:


```
![](//examples/big-grids.svg)
![](/examples/big-grids.svg)

### Complicated
```
Expand Down Expand Up @@ -259,7 +259,7 @@ Not Supported:
'-' '---------+--' / Nor/is this. ---

```
![](//examples/complicated.svg)
![](/examples/complicated.svg)

### More examples are [here](examples)

Expand All @@ -269,30 +269,30 @@ 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/dmullis/goat).
A nicely formatted reference may be found at [pkg.go.dev](https://pkg.go.dev/github.com/blampe/goat).

### Installation

```
$ go get -u github.com/dmullis/goat/
$ go get -u github.com/blampe/goat/
```
### Library Data Flow
![](//goat.svg)
![](/goat.svg)

The diagram above was derived by [./make.sh](./make.sh) from ASCII-art in the Go
The diagram above was derived by [./pre-push.sh](./pre-push.sh) from ASCII-art in the Go
source file [./goat.go](./goat.go).

#### Auto-formatted API docs

<!--
XX XX May need a Github Action to do this substitution at "push" time.
[![resource non-responsive](https://pkg.go.dev/badge/github.com/dmullis/goat)](https://pkg.go.dev/github.com/dmullis/goat)
[![resource non-responsive](https://pkg.go.dev/badge/github.com/blampe/goat)](https://pkg.go.dev/github.com/blampe/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/dmullis/goat?status.svg)](https://godocs.io/github.com/dmullis/goat)
[![resource non-responsive](https://godocs.io/github.com/blampe/goat?status.svg)](https://godocs.io/github.com/blampe/goat)
-->

### Project Tenets
Expand Down
24 changes: 12 additions & 12 deletions README.md.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ GoAT's [README.md](README.md), then finally rendered to HTML ```<img>``` element
```
{{.trees_txt}}
```
![]({{.Root}}/examples/trees.svg)
![](/examples/trees.svg)

### Trees -- mid-range color value
Setting a foreground color in the middle of the possible range of value or luminance
Expand All @@ -90,56 +90,56 @@ CSS property by
from within an enclosing `<img>` element such as are generated by Markdown.


![]({{.Root}}/trees.mid-blue.svg)
![](/trees.mid-blue.svg)

### Overlaps
```
{{.overlaps_txt}}
```
![]({{.Root}}/examples/overlaps.svg)
![](/examples/overlaps.svg)

### Line Decorations
```
{{.line_decorations_txt}}
```
![]({{.Root}}/examples/line-decorations.svg)
![](/examples/line-decorations.svg)

### Line Ends
```
{{.line_ends_txt}}
```
![]({{.Root}}/examples/line-ends.svg)
![](/examples/line-ends.svg)

### Dot Grids
```
{{.dot_grids_txt}}
```
Note that '·' above is not ASCII, but rather Unicode, the MIDDLE DOT character, encoded with UTF-8.
![]({{.Root}}/examples/dot-grids.svg)
![](/examples/dot-grids.svg)

### Large Nodes
```
{{.large_nodes_txt}}
```
![]({{.Root}}/examples/large-nodes.svg)
![](/examples/large-nodes.svg)

### Small Grids
```
{{.small_grids_txt}}
```
![]({{.Root}}/examples/small-grids.svg)
![](/examples/small-grids.svg)

### Big Grids
```
{{.big_grids_txt}}
```
![]({{.Root}}/examples/big-grids.svg)
![](/examples/big-grids.svg)

### Complicated
```
{{.complicated_txt}}
```
![]({{.Root}}/examples/complicated.svg)
![](/examples/complicated.svg)

### More examples are [here](examples)

Expand All @@ -157,9 +157,9 @@ A nicely formatted reference may be found at [pkg.go.dev](https://pkg.go.dev/git
$ go get -u github.com/{{.Github_Repository_Owner}}/goat/
```
### Library Data Flow
![]({{.Root}}/goat.svg)
![](/goat.svg)

The diagram above was derived by [./make.sh](./make.sh) from ASCII-art in the Go
The diagram above was derived by [./pre-push.sh](./pre-push.sh) from ASCII-art in the Go
source file [./goat.go](./goat.go).

#### Auto-formatted API docs
Expand Down
3 changes: 1 addition & 2 deletions pre-push.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,7 @@ then
fi

tmpl_expand () {
# XX Root="/" resolves to root of the repo -- consider dropping the variable.
go run ./cmd/tmpl-expand Root="/" Github_Repository_Owner=${GITHUB_REPOSITORY_OWNER} "$@"
go run ./cmd/tmpl-expand Github_Repository_Owner=${GITHUB_REPOSITORY_OWNER} "$@"
}

#tmpl_expand <go.tmpl.mod >go.mod
Expand Down
Loading