From 07edb2c3c66cf59b0be0699c012052edd407a167 Mon Sep 17 00:00:00 2001 From: Runxi Yu Date: Wed, 19 Mar 2025 12:45:25 +0800 Subject: [PATCH] Update README for the Go fork --- README.md | 29 +++++++++-------------------- diff --git a/README.md b/README.md index cb386c39ae95abe6cfda712ed1ebced674fd3434..b78e6c70a762f558ee3a34b1c2041aa1f339bd17 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,18 @@ -# hare-htmpl – A simple HTML templating engine +# go-htmpl – A simple HTML templating engine -This is a Hare port of the HTML templating engine used in +This is a Go port of the HTML templating engine used in [Got](https://got.gameoftrees.org/?action=summary&path=got.git) and described in [Omar Polo's blog post](https://www.omarpolo.com/post/template.html). -The `htmplgen` program generates a Hare file from the template file. +The `gohtmplgen` program generates a Go file from the template file. -The `htmpl` module provides auxiliary functions used by the generated Hare -code, and must be installed for the generated code to compile. - -Each template is presented as a function that accepts an `io::handle` and -other user-defined parameters, if any. The template writes to that -`io::handle`; this allows for a variety of output backends (i.e. you -could use a `memio`/`bufio` stream, or write to an actual -file/socket/pipe socket, etc.) - -## Repository migration notice - -The primary repository has been -[migrated onto the Lindenii Project's forge](https://forge.lindenii.runxiyu.org/hare/:/repos/hare-htmpl/). +Each template is presented as a function that accepts an +`net/http.ResponseWriter` and other user-defined parameters, if any. ## Dependencies -- [Hare](https://harelang.org) +- [Go](https://go.dev) - A POSIX-compatible Yacc implementation, such as [Bison](https://www.gnu.org/software/bison/) - A C compiler @@ -35,12 +24,12 @@ ## Contributing Create a branch that begins with `contrib/` and push to the -[main repo](https://forge.lindenii.runxiyu.org/hare/:/repos/hare-htmpl/) +[main repo](https://forge.lindenii.runxiyu.org/hare/:/repos/go-htmpl/) via SSH directly. ``` -git clone ssh://forge.lindenii.runxiyu.org/hare/:/repos/hare-htmpl/ -cd hare-htmpl +git clone ssh://forge.lindenii.runxiyu.org/hare/:/repos/go-htmpl/ +cd go-htmpl git checkout -b contrib/whatever # edit and commit stuff git push -u origin HEAD -- 2.48.1