From c84cc6ef6d4009947a9f6c9775f248120babd063 Mon Sep 17 00:00:00 2001 From: Daniel Barlow Date: Thu, 22 Dec 2022 22:52:37 +0000 Subject: [PATCH] convert doc to markdown --- Makefile | 2 ++ default.nix | 2 ++ doc/index.html | 46 ---------------------------------------------- doc/index.md | 32 ++++++++++++++++++++++++++++++++ 4 files changed, 36 insertions(+), 46 deletions(-) create mode 100644 Makefile delete mode 100644 doc/index.html create mode 100644 doc/index.md diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..92fe27a --- /dev/null +++ b/Makefile @@ -0,0 +1,2 @@ +doc/index.html: doc/index.md + pandoc -t html -f gfm < $< > $@ diff --git a/default.nix b/default.nix index 60baa13..66ed61b 100644 --- a/default.nix +++ b/default.nix @@ -14,6 +14,7 @@ , lua5_3 , makeDesktopItem , makeWrapper +, pandoc , webkitgtk , writeText }: @@ -48,6 +49,7 @@ in stdenv.mkDerivation rec { lua makeWrapper copyDesktopItems + pandoc ]; makeFlags = [ "PREFIX=${placeholder "out"}" ]; diff --git a/doc/index.html b/doc/index.html deleted file mode 100644 index 592c2fe..0000000 --- a/doc/index.html +++ /dev/null @@ -1,46 +0,0 @@ -Dunlin - -

Dunlin - a extensible Fennel-based web browser

- - - - -
The dunlin (Calidris alpina) is a small wader. It is a - circumpolar breeder in Arctic or subarctic regions. Birds that - breed in northern Europe and Asia are long-distance migrants, - wintering south to Africa, southeast Asia and the Middle - East. Birds that breed in Alaska and the Canadian Arctic migrate - short distances to the Pacific and Atlantic coasts of North - America, although those nesting in northern Alaska overwinter in - Asia.
- - - Dunlin is a GTK-based Webkit browser which can be extended in - (indeed, is mostly written in) - Fennel. - -

Hacking

- - 
-    $ nix-shell
-    nix-shell$ overmind start -D
-    nix-shell$ overmind connect
-
- - This starts a Fennel interpreter and a test runner in tmux windows. - Use 
C-b n
to switch between them or 
C-b d
- to detach. - - 
-    $ fennel dunlin.fnl &
-    $ ./repl.sh
-
- - Dunlin will open a socket in $XDG_RUNTIME_DIR to allow - communication with a Fennel REPL. The repl.sh script - uses socat - to connect to it. - - - diff --git a/doc/index.md b/doc/index.md new file mode 100644 index 0000000..0bc1fc5 --- /dev/null +++ b/doc/index.md @@ -0,0 +1,32 @@ +# Dunlin - a extensible Fennel-based web browser + + + +> The dunlin (Calidris alpina) is a small wader. It is a circumpolar +> breeder in Arctic or subarctic regions. Birds that breed in northern +> Europe and Asia are long-distance migrants, wintering south to Africa, +> southeast Asia and the Middle East. Birds that breed in Alaska and the +> Canadian Arctic migrate short distances to the Pacific and Atlantic +> coasts of North America, although those nesting in northern Alaska +> overwinter in Asia. + +Dunlin is a GTK-based Webkit browser which can be extended in (indeed, +is mostly written in) [Fennel](https://www.fennel-lang.org). + +## Hacking + + $ nix-shell + nix-shell$ overmind start -D + nix-shell$ overmind connect + + +This starts a Fennel interpreter and a test runner in tmux windows. Use `C-b n` +to switch between them or `C-b d` to detach. + + $ fennel dunlin.fnl & + $ ./repl.sh + + +Dunlin will open a socket in `$XDG_RUNTIME_DIR` to allow communication +with a Fennel REPL. The repl.sh script uses +[socat](http://www.dest-unreach.org/socat/) to connect to it.