dan/dunlin
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

convert doc to markdown

Browse Source
This commit is contained in:
Daniel Barlow 2022-12-22 22:52:37 +00:00
parent 25d31e0262
commit c84cc6ef6d
4 changed files with 36 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile Normal file
View File

@ -0,0 +1,2 @@
doc/index.html: doc/index.md
pandoc -t html -f gfm < $< > $@

2
default.nix
View File

@ -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"}" ];

46
doc/index.html
View File

@ -1,46 +0,0 @@
<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>

32
doc/index.md Normal file
View File

@ -0,0 +1,32 @@
# Dunlin - a extensible Fennel-based web browser
<img src="dunlin.png" data-align="right" style="width: 33%" />
> 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.