an offline-capable xkcd webcomic reader written in Go (wip)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
surtur 8142ed8cfe
app: add basic tabs
7 hours ago
cmd add copyright headers+enforce w/ addlicense 2 days ago
patches/diamondburned/go flake,go: add,use overlay.nix w/ patched Go 3 days ago
xkcdreader app: add basic tabs 7 hours ago
.drone.starlark ci(nix): run nixpkgs-fmt asap 1 day ago
.envrc direnv: add add_extra_vimrc hook [skip ci] 2 weeks ago
.gitattributes add .gitattributes [skip ci] 1 week ago
.gitignore ignore {.drone.{star,yml},*.out} files [skip ci] 1 week ago
.pre-commit-config.yaml add copyright headers+enforce w/ addlicense 2 days ago
.vimrc-example direnv: add add_extra_vimrc hook [skip ci] 2 weeks ago
LICENSE initial commit 2 months ago
README.md readme: add {godocsreference,goreportcard} badges 1 week ago
check-fmt add check-fmt convenience script 3 weeks ago
default.nix flake: add flake-compat+default.nix+shell.nix 4 weeks ago
flake.lock flake(nixpkgs): bump to 52dc75a4fe 3 days ago
flake.nix flake: add 'add-license' command 1 day ago
go.mod use github.com/spf13/cobra for app cmds 2 weeks ago
go.sum use github.com/spf13/cobra for app cmds 2 weeks ago
main.go add copyright headers+enforce w/ addlicense 2 days ago
main_test.go add copyright headers+enforce w/ addlicense 2 days ago
overlay.nix flake,go: add,use overlay.nix w/ patched Go 3 days ago
shell.nix flake: add flake-compat+default.nix+shell.nix 4 weeks ago

README.md

go-xkcdreader

an offline-capable xkcd webcomic reader written in Go

built with nix Cachix pre-commit Build Status Go Report Card Go Documentation

disclaimer

WIP 🚧

ad nix flake ❄

this project is provided as a nix flake for both convenience and reproducibility.
and also because I wanted to play with nix and its flakes just a wee bit.

note on the nix-related steps: make sure you have nix installed and optionally the flake functionality enabled, the Go toolchain and a minimal set of Go development goodies will get pulled in automatically. you might want to speed up the builds by making use of project's build cache: cachix use go-xkcdreader.

that means you can get started:

developing using nix (flakes enabled)

run nix develop in the project folder first, then go {run,build,fmt,...} about your day.

developing using nix (without flakes)

for compatibility with non-flake-enabled systems, this project uses github:edolstra/flake-compat.

run nix-shell in the project folder first, then go {run,build,fmt,...} about your day.

developing without nix

note: you only need to have the Go toolchain and Fyne dependencies installed for this.

if you don't want to use the flake provided or don't have nix installed, you can use the standard go tool: run go {run,build,fmt,...} in the project folder.

COPYING

Licensed under GPL-3.0-or-later (see LICENSE for details).