D build/readme.md

@@ -1,21 +0,0 @@
-## Requirements
-
-Go 1.23.4
-
-## Usage
-
-`./build <ROOT>`
-
-`<ROOT>` should be a path to the site's source directory.  The source directory must contain the following subdirectories and files:
-- `wiki/`
-- `assets`
-- `index.html`
-
-If `<ROOT>` is omitted, the current directory will be used as the source directory.
-
-
-### Flags
-- `--serve`, `-s`: Builds site, then serves built site on port 8000.  For previewing site, not for use in a live environment.
-
-### Creating a new wiki page
-Add a new name to `wiki.tab` at its proper place in the hierarchy and rerun the build. A new file will be created in the `/wiki/pages` directory with the proper template tags.

M index.html → index.html

@@ -234,10 +234,11 @@ </li>
                 <li>
                     <a href="/photos">photos</a>
                 </li>
+                 -->
                 <li>
-                    <a href="/git">git</a>
+                    <a href="https://git.deserthorns.net/">git</a>
                 </li>
-                <li>
+                <!-- <li>
                     <a href="/etc">etc</a>
                 </li> -->
             </ul>

A readme.md

@@ -0,0 +1,33 @@
+This repo contains the content and generator for [deserthorns.net](https://deserthorns.net/).
+
+## Generator (`build`)
+The site generator is written in Go and lives in the `build` directory.
+
+### Requirements
+
+Go 1.23.4
+
+### Usage
+
+`./build <ROOT>`
+
+`<ROOT>` should be a path to the site's source directory.  The source directory must contain the following subdirectories and files:
+- `wiki/`
+- `assets`
+- `index.html`
+
+If `<ROOT>` is omitted, the current directory will be used as the source directory.
+
+Generated files will be dropped in an `/out` directory in the working directory.
+
+
+#### Flags
+- `--serve`, `-s`: Builds site, then serves built site on port 8000.  For previewing site, not for use in a live environment. Live environment should serve the static files from the `/out` directory.
+
+#### Creating a new wiki page
+Add a new name to `wiki.tab` at its proper place in the hierarchy and rerun `./build`. A new file will be created in the `/wiki/pages` source directory with the proper template tags.
+
+### TODOs
+- Fast rebuild when serving locally using `-s` (press Enter to rebuild?)
+- Use YAML for `wiki.tab`?
+- Typography styling pass