dunlin/doc/index.html

47 lines
1.4 KiB
HTML

<html><head><title>Dunlin</title></head>
<body>
<h1>Dunlin - a extensible Fennel-based web browser</h1>
<img src="dunlin.png" align="right" style="width: 33%" />
<!-- original image is from
https://www.kansallisgalleria.fi/en/object/581328 -->
<blockquote>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.</blockquote>
</body>
Dunlin is a GTK-based Webkit browser which can be extended in
(indeed, is mostly written in)
<a href="https://www.fennel-lang.org">Fennel</a>.
<h2>Hacking</h2>
<pre>
$ nix-shell
nix-shell$ overmind start -D
nix-shell$ overmind connect
</pre>
This starts a Fennel interpreter and a test runner in tmux windows.
Use <pre>C-b n</pre> to switch between them or <pre>C-b d</pre>
to detach.
<pre>
$ fennel dunlin.fnl &
$ ./repl.sh
</pre>
Dunlin will open a socket in <tt>$XDG_RUNTIME_DIR</tt> to allow
communication with a Fennel REPL. The <tt>repl.sh</tt> script
uses <a href="http://www.dest-unreach.org/socat/">socat</a>
to connect to it.
</html>