Skip to content

Commit

Permalink
Merge pull request #106 from bengarrett/dev
Browse files Browse the repository at this point in the history
v1.0.1 update
  • Loading branch information
bengarrett authored Jan 10, 2024
2 parents ee3d94a + 86cd444 commit 965f9e6
Show file tree
Hide file tree
Showing 8 changed files with 52 additions and 62 deletions.
20 changes: 0 additions & 20 deletions .github/pull_request_template.md

This file was deleted.

8 changes: 1 addition & 7 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,11 @@
name: goreleaser

on:
pull_request:
push:
# run only against tags
tags:
- "*"
# only run when manually triggered
workflow_dispatch:

permissions:
contents: write
# packages: write
# issues: write

jobs:
goreleaser:
Expand Down
30 changes: 15 additions & 15 deletions docs/INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,45 +34,45 @@ In System Settings, Privacy & Security, Security, toggle **Allow applications do

```sh
# download the program
curl -OL https://github.com/bengarrett/retrotxtgo/releases/latest/download/retrotxtgo_darwin_all.tar.gz
$ curl -OL https://github.com/bengarrett/retrotxtgo/releases/latest/download/retrotxtgo_darwin_all.tar.gz

# decompress and unpack the program
tar -xvzf retrotxtgo_darwin_all.tar.gz
$ tar -xvzf retrotxtgo_darwin_all.tar.gz

# if needed, follow the itemized instructions above
# then run the command
retrotxt --version
$ retrotxt --version
```

### Linux
### DEB
```sh
# Debian DEB package
wget https://github.com/bengarrett/retrotxtgo/releases/latest/download/retrotxtgo.deb
dpkg -i retrotxtgo.deb
retrotxt -v
$ wget https://github.com/bengarrett/retrotxtgo/releases/latest/download/retrotxtgo.deb
$ dpkg -i retrotxtgo.deb
$ retrotxt -v
```

### RPM
```sh
# Redhat RPM package
wget https://github.com/bengarrett/retrotxtgo/releases/latest/download/retrotxtgo.rpm
rpm -i retrotxtgo.rpm
retrotxt -v
$ wget https://github.com/bengarrett/retrotxtgo/releases/latest/download/retrotxtgo.rpm
$ rpm -i retrotxtgo.rpm
$ retrotxt -v
```

### APK
```sh
# Alpine APK package
wget https://github.com/bengarrett/retrotxtgo/releases/latest/download/retrotxtgo.apk
apk add retrotxtgo.apk
retrotxt -v
$ wget https://github.com/bengarrett/retrotxtgo/releases/latest/download/retrotxtgo.apk
$ apk add retrotxtgo.apk
$ retrotxt -v
```

### ZST
```sh
# Arch ZST package
wget https://github.com/bengarrett/retrotxtgo/releases/latest/download/retrotxtgo.pkg.tar.zst
pacman -U retrotxtgo.pkg.tar.zst
retrotxt -v
$ wget https://github.com/bengarrett/retrotxtgo/releases/latest/download/retrotxtgo.pkg.tar.zst
$ pacman -U retrotxtgo.pkg.tar.zst
$ retrotxt -v
```
34 changes: 19 additions & 15 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Text files and art created before the adoption of Unicode often fail to display
#### Use RetroTxt to print legacy text on modern terminals.

```sh
retrotxt view ascii-logo.txt
$ retrotxt view ascii-logo.txt

██████╗ ███████╗████████╗██████╗ ██████╗ ████████╗██╗ ██╗████████╗
██╔══██╗██╔════╝╚══██╔══╝██╔══██╗██╔═══██╗╚══██╔══╝╚██╗██╔╝╚══██╔══╝
Expand All @@ -34,15 +34,15 @@ retrotxt view ascii-logo.txt
#### Or save it to a Unicode file and use it in other apps.

```sh
retrotxt view ascii-logo.txt > ascii-logo-utf8.txt
$ retrotxt view ascii-logo.txt > ascii-logo-utf8.txt
```

![Windows Notepad viewing ascii-logo-utf8.txt](img/ascii-logo-utf8.txt.png)

Otherwise, legacy text is often malformed and unreadable when using most terminal apps.

```sh
type ascii-logo.txt # or, cat ascii-logo.txt
$ type ascii-logo.txt # or, cat ascii-logo.txt

�����ۻ ������ۻ�������ۻ�����ۻ �����ۻ �������ۻ�ۻ �ۻ�������ۻ
������ۻ������ͼ�������ͼ������ۻ�������ۻ�������ͼ��ۻ��ɼ�������ͼ
Expand All @@ -59,7 +59,7 @@ type ascii-logo.txt # or, cat ascii-logo.txt
### Swedish text

```
cat 14670.txt
$ cat 14670.txt
�mnet d�r, fortfor den andre, r�r till en del de antika gallerna; men
f�r det mesta sker h�ndelserna i andev�rlden.
Expand All @@ -74,7 +74,7 @@ End of the Project Gutenberg EBook of Det g�r an, by Carl Jonas Love Almqvist
```

```
retrotxt 14670.txt --input latin1
$ retrotxt 14670.txt --input latin1
Ämnet där, fortfor den andre, rör till en del de antika gallerna; men
för det mesta sker händelserna i andevärlden.
Expand All @@ -91,12 +91,12 @@ End of the Project Gutenberg EBook of Det går an, by Carl Jonas Love Almqvist
### Japanese text

```sh
cat rshmn10j.txt
$ cat rshmn10j.txt
# no text is displayed as the text isn't ASCII compatible
```

```
retrotxt rshmn10j.txt --input shiftjis
$ retrotxt rshmn10j.txt --input shiftjis
 暫、死んだように倒れていた老婆が、屍骸の中から、その裸の体を起こしたのは、そ
れから間もなくの事である。老婆は、つぶやくような、うめくような声を立てながら、
Expand All @@ -109,7 +109,7 @@ retrotxt rshmn10j.txt --input shiftjis
### Cyrillic text

```
cat olavg10.txt
$ cat olavg10.txt
"������ � ��� ���������, ����� ���,
���� ������� ����, �������
Expand All @@ -124,7 +124,7 @@ cat olavg10.txt
```

```
retrotxt olavg10.txt --input cp1251
$ retrotxt olavg10.txt --input cp1251
"Честит е тоз избранник, чийто дух,
като ковчега Ноев, пренесе
Expand Down Expand Up @@ -156,7 +156,7 @@ retrotxt olavg10.txt --input cp1251
### Known code pages and text encodings

```
retrotxt list
$ retrotxt list
──────────────────────────────────────────────────────────────────────────────
Formal name | Named value | Numeric value | Alias value |
Expand Down Expand Up @@ -228,7 +228,7 @@ retrotxt list
#### Print legacy code page tables in the terminal.

```
retrotxt table cp437 latin1
$ retrotxt table cp437 latin1
―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――
IBM Code Page 437 (DOS, OEM-US) - Extended ASCII
Expand Down Expand Up @@ -274,7 +274,7 @@ retrotxt table cp437 latin1
#### Print the file information and embed SAUCE metadata.

```
retrotxt info retrotxt.ans
$ retrotxt info retrotxt.ans
────────────────────────────────────────────────────────────────────────────────
File information
Expand Down Expand Up @@ -311,7 +311,7 @@ retrotxt info retrotxt.ans
```

```sh
retrotxt info retrotxt.ans --format json
$ retrotxt info retrotxt.ans --format json
```

```json
Expand Down Expand Up @@ -425,7 +425,7 @@ retrotxt info retrotxt.ans --format json
#### Dump the hexadecimal bytes of a file.

```sh
retrotxt dump sauce-embed.txt
$ retrotxt dump sauce-embed.txt
```

```
Expand Down Expand Up @@ -520,4 +520,8 @@ retrotxt dump sauce-embed.txt
00000580 32 36 81 0e 00 00 01 00 d1 03 09 00 00 00 00 00 |26..............|
00000590 01 13 49 42 4d 20 56 47 41 00 00 00 00 00 00 00 |..IBM VGA.......|
000005a0 00 00 00 00 00 00 00 00 |........|
```
```

---

### [Also available is RetroTxt, the browser Extension](https://github.com/bengarrett/RetroTxt) that turns ANSI, ASCII, and NFO text into web documents.
4 changes: 4 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
### Version 1.0.1

- Dependency updates.

### Version 1.0.0

- Initial release.
8 changes: 4 additions & 4 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ require (
github.com/muesli/go-app-paths v0.2.2
github.com/spf13/cobra v1.8.0
github.com/zRedShift/mimemagic v1.2.0
golang.org/x/net v0.19.0 // indirect
golang.org/x/net v0.20.0 // indirect
golang.org/x/sync v0.6.0
golang.org/x/sys v0.16.0 // indirect
golang.org/x/term v0.16.0
Expand All @@ -20,10 +20,10 @@ require (
)

require (
github.com/bengarrett/bbs v0.1.0
github.com/bengarrett/sauce v1.1.0
github.com/bengarrett/bbs v1.0.1
github.com/bengarrett/sauce v1.2.1
github.com/stretchr/testify v1.8.4
golang.org/x/exp v0.0.0-20240103183307-be819d1f06fc
golang.org/x/exp v0.0.0-20240110193028-0dcbfd608b1e
gopkg.in/yaml.v3 v3.0.1
)

Expand Down
8 changes: 8 additions & 0 deletions go.sum
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
github.com/bengarrett/bbs v0.1.0 h1:jK7s7UhbjQRPCpbjErWmA60PKq1zXHmOOSYAfzY9VnU=
github.com/bengarrett/bbs v0.1.0/go.mod h1:Q9Z2NiscHyRX02VvtWDTlwjEgAC3KvxO1wShoGA36Kg=
github.com/bengarrett/bbs v1.0.1 h1:3uw5R3GemhPZJGsA9aYTEi5Hqq/7j/WRAiPUXgDuES8=
github.com/bengarrett/bbs v1.0.1/go.mod h1:tTgo2YOKWoIFJmQigSbxe5cmbrGSfpieLM3QUvMXzyk=
github.com/bengarrett/sauce v1.1.0 h1:DJOPdg4u01V75P+GhTw4i1JP4dXsRi/Q+PlZG6UIojU=
github.com/bengarrett/sauce v1.1.0/go.mod h1:7DnrHtFgugm6J+rZbvZIOyxhoR2iQTy9vogS1Mtqp6E=
github.com/bengarrett/sauce v1.2.1 h1:eLcIksN1q0O5uF2CDNVUCWnHpIU9zq7kAqECfkvBCEY=
github.com/bengarrett/sauce v1.2.1/go.mod h1:Wy8xgqM56krrRP1xgjBd7kw4/Dn5KJX+xtwzwmg0YmM=
github.com/cpuguy83/go-md2man/v2 v2.0.3/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
Expand Down Expand Up @@ -47,9 +51,13 @@ github.com/zRedShift/mimemagic v1.2.0 h1:tfX2W91dg2wG8YyZAPmameP6q1YuuIw3TveWbc7
github.com/zRedShift/mimemagic v1.2.0/go.mod h1:duzwAfYjsWttqB0a7CuXPvriYZ96ytLW0zMfMxDhXCY=
golang.org/x/exp v0.0.0-20240103183307-be819d1f06fc h1:ao2WRsKSzW6KuUY9IWPwWahcHCgR0s52IfwutMfEbdM=
golang.org/x/exp v0.0.0-20240103183307-be819d1f06fc/go.mod h1:iRJReGqOEeBhDZGkGbynYwcHlctCvnjTYIamk7uXpHI=
golang.org/x/exp v0.0.0-20240110193028-0dcbfd608b1e h1:723BNChdd0c2Wk6WOE320qGBiPtYx0F0Bbm1kriShfE=
golang.org/x/exp v0.0.0-20240110193028-0dcbfd608b1e/go.mod h1:iRJReGqOEeBhDZGkGbynYwcHlctCvnjTYIamk7uXpHI=
golang.org/x/net v0.0.0-20181017193950-04a2e542c03f/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
golang.org/x/net v0.19.0 h1:zTwKpTd2XuCqf8huc7Fo2iSy+4RHPd10s4KzeTnVr1c=
golang.org/x/net v0.19.0/go.mod h1:CfAk/cbD4CthTvqiEl8NpboMuiuOYsAr/7NOjZJtv1U=
golang.org/x/net v0.20.0 h1:aCL9BSgETF1k+blQaYUBx9hJ9LOGP3gAVemcZlf1Kpo=
golang.org/x/net v0.20.0/go.mod h1:z8BVo6PvndSri0LbOE3hAn0apkU+1YvI6E70E9jsnvY=
golang.org/x/sync v0.6.0 h1:5BMeUDZ7vkXGfEr1x9B4bRcTH4lpkTkpdh0T/J+qjbQ=
golang.org/x/sync v0.6.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
Expand Down
2 changes: 1 addition & 1 deletion meta/meta.go
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ const (
// URL for this program's website.
URL = "https://retrotxt.com/go"
// Copyright © year range.
Copyright = "2020-23"
Copyright = "2020-24"
)

// String returns the release version string.
Expand Down

0 comments on commit 965f9e6

Please sign in to comment.