about summary refs log tree commit diff homepage
path: root/README.md
diff options
context:
space:
mode:
authorNguyễn Gia Phong <mcsinyx@disroot.org>2023-01-26 02:52:21 +0900
committerNguyễn Gia Phong <mcsinyx@disroot.org>2023-01-26 02:52:21 +0900
commitea1e82c58d4b36f5ac194f6b901425cdf99f2661 (patch)
tree2db28963f0aff04b822ad4c8ee5ff5c0cec98e60 /README.md
parentf7720b2207b33fd60ef945662c261c1468e377f7 (diff)
downloadpx-ea1e82c58d4b36f5ac194f6b901425cdf99f2661.tar.gz
Add live reloading facilities
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1b004ef
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# My photo gallery
+
+This is a static site (with immutable DOM as usual)
+for displaying my photos.
+
+## Hacking
+
+Run `nix-shell live.nix` and open `http://localhost:28792`.
+Changes to `*/index.xml` will be live reloaded thanks
+to modern browsers' native support for XSLT.  The web feed
+has to me manually regenerated with `make atom.xml` however.
+
+## Deployment
+
+```sh
+rsync -avh --delete\
+  $(nix-build -E 'with import <nixpkgs> {}; callPackage ./. {}')/\
+  loang:/var/lib/www/px.cnx.gdn/
+```
+
+Nix builds are reproducible which helps minimize the amount of file transfer.
+
+## Copying
+
+![CC BY-SA](https://i.creativecommons.org/l/by-sa/4.0/88x31.png)
+
+This site is licensed under a [Creative Commons Attribution-ShareAlike 4.0
+International License](https://creativecommons.org/licenses/by-sa/4.0/).