aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSamuel Johnson <[email protected]>2025-05-04 18:02:25 -0400
committerSamuel Johnson <[email protected]>2025-05-04 18:02:25 -0400
commitd1cf1776a39c899808edc00c39ee282b678d0b99 (patch)
treeb10c3c40035b7c73c86614e8dabaf600f842c377
parent10952243e392da298c5d42cd330d8a65b819ada8 (diff)
Add README
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..50429be
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# Source code for my blog
+
+Exactly what it says on the tin. Should be usable for other blogs with some tweaking.
+
+To get it to work properly, you need a .env file, with the following fields:
+- `webmaster` the name of the blog owner
+- `web_port` the port to host the site on
+- `parser_port` the port to host the markdown parser on
+- `db_user` which db you're storing the built blog entries in
+- `db_pass` the password for that db
+- `audio_dir` the directory with your songs (in mp3 format)