summaryrefslogtreecommitdiff
path: root/README.txt
diff options
context:
space:
mode:
authorSteph Enders <steph@senders.io>2023-06-21 22:56:23 -0400
committerSteph Enders <steph@senders.io>2023-06-21 22:56:23 -0400
commit06bd3d7999501ee178826190fbd3b4a9e28cb6fa (patch)
tree86b181a3162581df70269439793df0810ac463ed /README.txt
parent80c1478e5af73f22cd26b667a371d4fb182647f7 (diff)
Create simple template script for deployment
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.txt b/README.txt
index 5b35135..0218361 100644
--- a/README.txt
+++ b/README.txt
@@ -3,3 +3,24 @@
The Woman In My Eye is a trans blog recounting my journey as a transgender woman.
You can find me on Fedi @senders@tech.lgbt if you have any questions.
+
+== Structure
+
+The files are structured into the following folders:
+
+templates/
+ These are template files that can be injected by {name} into any HTML document.
+entries/
+ These are all files that will be rendered into the www/ folder
+www/
+ These are the production ready files
+
+static/
+ These are static files that will be copied to the www folder based on their existing folder structure
+
+== Scripts
+
+./render.sh <file> www/<path>
+ Renders a given entry into the path destination
+./make.sh
+ Will build the entire website!