2022-03-12 10:29:25 +01:00
|
|
|
# [go-xkcdreader](https://git.dotya.ml/wanderer/go-xkcdreader)
|
|
|
|
|
|
|
|
|
|
> an offline-capable xkcd webcomic reader written in Go
|
|
|
|
|
|
2022-04-26 21:32:50 +02:00
|
|
|
[](https://builtwithnix.org)
|
2022-05-03 19:18:22 +02:00
|
|
|
[](https://go-xkcdreader.cachix.org)
|
2022-05-13 22:58:09 +02:00
|
|
|
[](https://github.com/pre-commit/pre-commit)
|
2022-05-06 22:25:38 +02:00
|
|
|
[](https://drone.dotya.ml/wanderer/go-xkcdreader)
|
2022-05-13 23:06:21 +02:00
|
|
|
[](https://goreportcard.com/report/git.dotya.ml/wanderer/go-xkcdreader)
|
|
|
|
|
[](https://godocs.io/git.dotya.ml/wanderer/go-xkcdreader)
|
2022-04-26 21:32:50 +02:00
|
|
|
|
2022-03-12 10:29:25 +01:00
|
|
|
### disclaimer
|
|
|
|
|
WIP :construction:
|
|
|
|
|
|
2022-04-26 14:52:34 +02:00
|
|
|
### 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`](https://nixos.org/learn.html) installed and optionally the flake
|
|
|
|
|
> functionality enabled, the Go toolchain and a minimal set of Go development
|
2022-05-03 19:18:22 +02:00
|
|
|
> 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`.
|
2022-04-26 14:52:34 +02:00
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
2022-04-26 15:08:36 +02:00
|
|
|
### developing using nix (without flakes)
|
|
|
|
|
> for compatibility with non-flake-enabled systems, this project uses
|
|
|
|
|
> [`github:edolstra/flake-compat`](https://github.com/edolstra/flake-compat).
|
|
|
|
|
|
|
|
|
|
run `nix-shell` in the project folder *first*, then `go {run,build,fmt,...}`
|
|
|
|
|
about your day.
|
|
|
|
|
|
2022-04-26 14:52:34 +02:00
|
|
|
### developing without nix
|
|
|
|
|
> *note*: you only need to have the Go toolchain and [Fyne
|
|
|
|
|
> dependencies](https://developer.fyne.io/started/#prerequisites) 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.
|
|
|
|
|
|
|
|
|
|
|
2022-03-12 10:29:25 +01:00
|
|
|
### COPYING
|
|
|
|
|
Licensed under GPL-3.0-or-later (see [LICENSE](LICENSE) for details).
|
