docs: add installation info for FreeBSD

ci/generate-docs.py

@@ -121,6 +121,7 @@ TOC = [
                     Page("Windows", "install/windows.md"),
                     Page("macOS", "install/macos.md"),
                     Page("Linux", "install/linux.md"),
+                    Page("FreeBSD", "install/freebsd.md"),
                     Page("Build from source", "install/source.md"),
                 ],
             ),

ci/subst-release-info.py

@@ -30,6 +30,7 @@ CATEGORIZE = {
     r"^WezTerm-.*.setup.exe$": "windows_exe",
 }
 
+
 def categorize(rel):
     downloads = {}
 
@@ -44,8 +45,10 @@ def categorize(rel):
 
     return downloads
 
+
 def pretty(o):
-    return json.dumps(o, indent=4, sort_keys=True, separators=(',', ':'))
+    return json.dumps(o, indent=4, sort_keys=True, separators=(",", ":"))
+
 
 def build_subst(subst, stable, categorized):
     for (kind, info) in categorized.items():
@@ -57,6 +60,7 @@ def build_subst(subst, stable, categorized):
         subst["{{ %s_asset }}" % kind] = name
         subst["{{ %s_dir }}" % kind] = dir
 
+
 def load_release_info():
     with open("/tmp/wezterm.releases.json") as f:
         release_info = json.load(f)
@@ -71,15 +75,21 @@ def load_release_info():
     latest = categorize(latest)
     nightly = categorize(nightly)
 
-    print('latest: ', pretty(latest))
-    print('nightly: ', pretty(nightly))
+    print("latest: ", pretty(latest))
+    print("nightly: ", pretty(nightly))
 
     subst = {}
     build_subst(subst, "stable", latest)
     build_subst(subst, "nightly", nightly)
     print(pretty(subst))
 
-    for name in ['install/windows', 'install/macos', 'install/linux', 'install/source']:
+    for name in [
+        "install/windows",
+        "install/macos",
+        "install/linux",
+        "install/source",
+        "install/freebsd",
+    ]:
         with open(f"docs/{name}.markdown", "r") as input:
             with open(f"docs/{name}.md", "w") as output:
                 for line in input:
@@ -87,7 +97,9 @@ def load_release_info():
                         line = line.replace(search, replace)
                     output.write(line)
 
+
 def main():
     load_release_info()
 
+
 main()

docs/install/freebsd.markdown

@@ -0,0 +1,15 @@
+## Installing on FreeBSD
+
+WezTerm is available [via the ports system](https://www.freshports.org/x11/wezterm/).
+
+The most common FreeBSD architectures have pre-built binaries which you can install via:
+
+```bash
+$ pkg install wezterm
+```
+
+The version available in ports is not directly managed by the release
+automation of the WezTerm project and may lag behind the latest release.  If
+you need to run a newer version, then the [build from source](source.md)
+instructions also apply to FreeBSD.
+

docs/installation.md

@@ -1,8 +1,9 @@
-Wezterm is available pre-built for the major platforms and, because it is open
+WezTerm is available pre-built for the major platforms and, because it is open
 source, you may also build it for yourself.
 
  - [Windows](install/windows.md)
  - [macOS](install/macos.md)
  - [Linux](install/linux.md)
+ - [FreeBSD](install/freebsd.md)
  - [Build from source](install/source.md)