convert readme to nfo; convert docs to txtHEADmain

1 files changed, 47 insertions, 0 deletions

diff --git a/README.nfo b/README.nfo
new file mode 100644
index 0000000..39d14cb
--- /dev/null
+++ b/README.nfo
@@ -0,0 +1,47 @@
+┌──────────────────────────────────────────────────────────────┐
+│  S K U N K Y A R T                         [ KRZ ]   krz.sh  │
+└──────────────────────────────────────────────────────────────┘
+
+FORK
+  fork of SkunkyArt (https://git.macaw.me/skunky/SkunkyArt). upstream
+  hasn't updated in over a year, has open bugs, and its listed
+  instances are dead links. this fork keeps it maintained.
+
+WHAT
+  skunkyart. alternative frontend for deviantart. works with no
+  javascript.
+
+  instances: INSTANCES.txt
+
+BUILD
+  build with the embed tag to embed presets in the binary. skip the
+  tag if you'll modify templates. add -ldflags "-w -s" (gccgo:
+  gccgoflags) to shrink the output:
+
+      go build -tags embed -ldflags "-w -s"
+
+  that build reports its version as dev. stamp one in with
+  -X main.version=<version>, as the release workflow does from the
+  git tag.
+
+DOCKER
+  multi-arch images (linux/amd64, linux/arm64) publish to ghcr on
+  every release tag:
+
+      docker pull ghcr.io/krazywarez/skunky-art:latest
+
+  each release is tagged 1.3.3, 1.3, 1, and latest. pin an exact
+  version for reproducible upgrades. compose.example.yaml uses the
+  image; compose.vpn_example.yml adds an optional vpn egress sidecar.
+
+CONFIG
+  sample config in config.example.json. custom config with --config.
+  directive details in SETUP.txt.
+
+INSTANCES
+  add yours by pr to instances.json and INSTANCES.txt (or use
+  --add-instance to write both), or open an issue.
+
+┌──────────────────────────────────────────────────────────────┐
+│  krz.sh                                                      │
+└──────────────────────────────────────────────────────────────┘