diff options
| author | Christian Cleberg <[email protected]> | 2026-08-02 15:29:37 -0500 |
|---|---|---|
| committer | Christian Cleberg <[email protected]> | 2026-08-02 15:35:14 -0500 |
| commit | 7acbd87221f6e4594edf3db029520997027a7bed (patch) | |
| tree | 7b838fae724f3bb0375df0d0138b8387f58b50c5 | |
| parent | 4178e3893f310425e76f6d4515af9e7d0ea36a0a (diff) | |
| download | skunky-art-7acbd87221f6e4594edf3db029520997027a7bed.tar.gz skunky-art-7acbd87221f6e4594edf3db029520997027a7bed.tar.bz2 skunky-art-7acbd87221f6e4594edf3db029520997027a7bed.zip | |
| -rwxr-xr-x | INSTANCES.txt (renamed from INSTANCES.md) | 0 | ||||
| -rwxr-xr-x | README.md | 47 | ||||
| -rw-r--r-- | README.nfo | 47 | ||||
| -rwxr-xr-x | REDIRECTS.txt (renamed from REDIRECTS.md) | 0 | ||||
| -rwxr-xr-x | SETUP.txt (renamed from SETUP.md) | 0 | ||||
| -rwxr-xr-x | TODO.txt (renamed from TODO.md) | 0 |
6 files changed, 47 insertions, 47 deletions
diff --git a/INSTANCES.md b/INSTANCES.txt index b47d1b8..b47d1b8 100755 --- a/INSTANCES.md +++ b/INSTANCES.txt diff --git a/README.md b/README.md deleted file mode 100755 index 205fe36..0000000 --- a/README.md +++ /dev/null @@ -1,47 +0,0 @@ -> [!NOTE] -> This is a fork of [SkunkyArt](https://git.macaw.me/skunky/SkunkyArt). The -> upstream repository has not been updated in over a year, contains a number of -> unresolved bugs, and all of its previously listed instances were found to be -> dead links. This fork exists to keep the project maintained. - -<img src="static/images/logo.png" alt="SkunkyArt" title="SkunkyArt Logo" width="20%" loading="lazy"/> - -Instances: [`INSTANCES.md`](INSTANCES.md) - -## Description -SkunkyArt 🦨 — an alternative frontend for DeviantArt that works entirely -without JavaScript. - -## Build -It is recommended to build with the 'embed' tag because it embeds the presets in -the binary. If you plan to modify the templates, then do not use this tag. You -can also add the `-ldflags "-w -s"` argument (GCCGO has a different name for it -— `gccgoflags`) to reduce the size of the output file. Here is an example: - -`go build -tags embed -ldflags "-w -s"` - -Such a build reports its version as `dev`. To stamp one in, as the release -workflow does from the git tag, add `-X main.version=<version>` to the ldflags. - -## Docker -Prebuilt multi-arch images (`linux/amd64`, `linux/arm64`) are published 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 if -you want reproducible upgrades. `compose.example.yaml` uses this image by -default and keeps a commented-out `build: .` for building from a checkout. -`compose.vpn_example.yml` does the same, plus an optional VPN egress sidecar. - -## Setup -The sample config is in the `config.example.json` file. For custom config, use -the `--config` option. - -See the [`SETUP.md`](SETUP.md) file for more info about directives. - -## Adding instance to the list -To do this, you must either make a PR by adding your instance to the -`instances.json` and `INSTANCES.md` files (you can use `--add-instance` -cli-argument to automatically add the instance to these files) or create an -Issue. 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 │ +└──────────────────────────────────────────────────────────────┘ diff --git a/REDIRECTS.md b/REDIRECTS.txt index 2469977..2469977 100755 --- a/REDIRECTS.md +++ b/REDIRECTS.txt |
