]> Humopery - waterslager.git/commitdiff
Better documentation
authorfozzie <fozzie@humopery.space>
Tue, 22 Jul 2025 00:09:45 +0000 (19:09 -0500)
committerfozzie <fozzie@humopery.space>
Tue, 22 Jul 2025 00:09:45 +0000 (19:09 -0500)
README.md

index 7d2b1f347c999d1a0edcf996d17423ecd291b4a9..5a0439358f46b4974e44cdd6fa2625de5c445863 100644 (file)
--- a/README.md
+++ b/README.md
@@ -6,9 +6,23 @@ A waterslager is a type of canary.
 
 ## Local development
 
-1. 'cargo run' as normal
+1. If desired, set development values in .env
 
-2. Open http://localhost:3000
+2. 'cargo run' as normal
+
+3. Open http://localhost:3000
+
+## Building
+
+```NETTLE_STATIC=yes cargo build```
+
+You probably need to install nettle's static libs through your package manager. You can omit the flag but the binary that links dynamically against nettle may have linkage problems when deployed to another host.
+
+## Running in production
+
+Set APP_ROOT=/foo to run the application in a subpath.
+
+Set RUST_LOG=info for more verbose output.
 
 ## Adding a trusted signer cert