Commit 7acbd87221
Unsigned
Layout: unified · split
INSTANCES.md → INSTANCES.txt renamed
README.md deleted −47
| @@ -1,47 +0,0 @@ | ||
| 1 | > [!NOTE] | |
| 2 | > This is a fork of [SkunkyArt](https://git.macaw.me/skunky/SkunkyArt). The | |
| 3 | > upstream repository has not been updated in over a year, contains a number of | |
| 4 | > unresolved bugs, and all of its previously listed instances were found to be | |
| 5 | > dead links. This fork exists to keep the project maintained. | |
| 6 | ||
| 7 | <img src="static/images/logo.png" alt="SkunkyArt" title="SkunkyArt Logo" width="20%" loading="lazy"/> | |
| 8 | ||
| 9 | Instances: [`INSTANCES.md`](INSTANCES.md) | |
| 10 | ||
| 11 | ## Description | |
| 12 | SkunkyArt 🦨 — an alternative frontend for DeviantArt that works entirely | |
| 13 | without JavaScript. | |
| 14 | ||
| 15 | ## Build | |
| 16 | It is recommended to build with the 'embed' tag because it embeds the presets in | |
| 17 | the binary. If you plan to modify the templates, then do not use this tag. You | |
| 18 | can also add the `-ldflags "-w -s"` argument (GCCGO has a different name for it | |
| 19 | — `gccgoflags`) to reduce the size of the output file. Here is an example: | |
| 20 | ||
| 21 | `go build -tags embed -ldflags "-w -s"` | |
| 22 | ||
| 23 | Such a build reports its version as `dev`. To stamp one in, as the release | |
| 24 | workflow does from the git tag, add `-X main.version=<version>` to the ldflags. | |
| 25 | ||
| 26 | ## Docker | |
| 27 | Prebuilt multi-arch images (`linux/amd64`, `linux/arm64`) are published to GHCR | |
| 28 | on every release tag: | |
| 29 | ||
| 30 | `docker pull ghcr.io/krazywarez/skunky-art:latest` | |
| 31 | ||
| 32 | Each release is tagged `1.3.3`, `1.3`, `1` and `latest`; pin an exact version if | |
| 33 | you want reproducible upgrades. `compose.example.yaml` uses this image by | |
| 34 | default and keeps a commented-out `build: .` for building from a checkout. | |
| 35 | `compose.vpn_example.yml` does the same, plus an optional VPN egress sidecar. | |
| 36 | ||
| 37 | ## Setup | |
| 38 | The sample config is in the `config.example.json` file. For custom config, use | |
| 39 | the `--config` option. | |
| 40 | ||
| 41 | See the [`SETUP.md`](SETUP.md) file for more info about directives. | |
| 42 | ||
| 43 | ## Adding instance to the list | |
| 44 | To do this, you must either make a PR by adding your instance to the | |
| 45 | `instances.json` and `INSTANCES.md` files (you can use `--add-instance` | |
| 46 | cli-argument to automatically add the instance to these files) or create an | |
| 47 | Issue. | |
README.nfo added +47
| @@ -0,0 +1,47 @@ | ||
| 1 | ┌──────────────────────────────────────────────────────────────┐ | |
| 2 | │ S K U N K Y A R T [ KRZ ] krz.sh │ | |
| 3 | └──────────────────────────────────────────────────────────────┘ | |
| 4 | ||
| 5 | FORK | |
| 6 | fork of SkunkyArt (https://git.macaw.me/skunky/SkunkyArt). upstream | |
| 7 | hasn't updated in over a year, has open bugs, and its listed | |
| 8 | instances are dead links. this fork keeps it maintained. | |
| 9 | ||
| 10 | WHAT | |
| 11 | skunkyart. alternative frontend for deviantart. works with no | |
| 12 | javascript. | |
| 13 | ||
| 14 | instances: INSTANCES.txt | |
| 15 | ||
| 16 | BUILD | |
| 17 | build with the embed tag to embed presets in the binary. skip the | |
| 18 | tag if you'll modify templates. add -ldflags "-w -s" (gccgo: | |
| 19 | gccgoflags) to shrink the output: | |
| 20 | ||
| 21 | go build -tags embed -ldflags "-w -s" | |
| 22 | ||
| 23 | that build reports its version as dev. stamp one in with | |
| 24 | -X main.version=<version>, as the release workflow does from the | |
| 25 | git tag. | |
| 26 | ||
| 27 | DOCKER | |
| 28 | multi-arch images (linux/amd64, linux/arm64) publish to ghcr on | |
| 29 | every release tag: | |
| 30 | ||
| 31 | docker pull ghcr.io/krazywarez/skunky-art:latest | |
| 32 | ||
| 33 | each release is tagged 1.3.3, 1.3, 1, and latest. pin an exact | |
| 34 | version for reproducible upgrades. compose.example.yaml uses the | |
| 35 | image; compose.vpn_example.yml adds an optional vpn egress sidecar. | |
| 36 | ||
| 37 | CONFIG | |
| 38 | sample config in config.example.json. custom config with --config. | |
| 39 | directive details in SETUP.txt. | |
| 40 | ||
| 41 | INSTANCES | |
| 42 | add yours by pr to instances.json and INSTANCES.txt (or use | |
| 43 | --add-instance to write both), or open an issue. | |
| 44 | ||
| 45 | ┌──────────────────────────────────────────────────────────────┐ | |
| 46 | │ krz.sh │ | |
| 47 | └──────────────────────────────────────────────────────────────┘ | |