wanderer/go-xkcdreader
1
1
Fork 0
Code Issues 5 Pull Requests Releases Activity
an offline-capable xkcd webcomic reader written in Go (wip)
47 Commits 6 Branches 0 Tags 2.3 MiB
Go 50%
Nix 26.7%
Starlark 23.3%
dabb229e07
Go to file
surtur dabb229e07
pre-commit(golang): rm go-lint, add revive,go-sec 
[skip ci]
2022-05-24 11:44:55 +02:00
cmd add copyright headers+enforce w/ addlicense 2022-05-21 00:49:13 +02:00
patches/diamondburned/go flake,go: add,use overlay.nix w/ patched Go 2022-05-20 19:52:31 +02:00
xkcdreader app(xkcdreader): init,get fyne.App from anywhere 2022-05-23 17:56:24 +02:00
.drone.starlark ci(nix): run nixpkgs-fmt asap 2022-05-21 21:47:27 +02:00
.envrc direnv: add add_extra_vimrc hook [skip ci] 2022-05-08 20:16:46 +02:00
.gitattributes add .gitattributes [skip ci] 2022-05-13 22:59:17 +02:00
.gitignore ignore {.drone.{star,yml},*.out} files [skip ci] 2022-05-13 22:36:41 +02:00
.pre-commit-config.yaml pre-commit(golang): rm go-lint, add revive,go-sec 2022-05-24 11:44:55 +02:00
.vimrc-example direnv: add add_extra_vimrc hook [skip ci] 2022-05-08 20:16:46 +02:00
check-fmt add check-fmt convenience script 2022-05-03 18:22:48 +02:00
default.nix flake: add flake-compat+default.nix+shell.nix 2022-04-26 15:08:36 +02:00
flake.lock flake(nixpkgs): bump to 52dc75a4fe 2022-05-20 14:04:58 +02:00
flake.nix flake: add 'add-license' command 2022-05-21 22:05:36 +02:00
go.mod use github.com/spf13/cobra for app cmds 2022-05-12 15:54:16 +02:00
go.sum use github.com/spf13/cobra for app cmds 2022-05-12 15:54:16 +02:00
LICENSE initial commit 2022-03-12 10:29:25 +01:00
main_test.go add copyright headers+enforce w/ addlicense 2022-05-21 00:49:13 +02:00
main.go add copyright headers+enforce w/ addlicense 2022-05-21 00:49:13 +02:00
overlay.nix flake,go: add,use overlay.nix w/ patched Go 2022-05-20 19:52:31 +02:00
README.md readme: add {godocsreference,goreportcard} badges 2022-05-13 23:06:21 +02:00
shell.nix flake: add flake-compat+default.nix+shell.nix 2022-04-26 15:08:36 +02:00

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).