From 486ac1f4901c004f8a1a290e86d45bb1078584ba Mon Sep 17 00:00:00 2001
From: TakeV <takev@disroot.org>
Date: Fri, 2 Feb 2024 20:05:40 -0500
Subject: [PATCH] Add README.org

---
 README.org | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 README.org

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..6888b26
--- /dev/null
+++ b/README.org
@@ -0,0 +1,45 @@
+#+#+title: Solarpunk Mastodon
+
+The solarpunk.moe mastodon configuration and customizations.
+
+* Build
+
+Building the project requires a couple of steps.
+
+** Copy files
+To build, copy the content of this folder to a copy of the mastodon source code, then =docker compose build=.
+
+Assuming that your local mastodon checkout is located at =~/src/mastodon=, you can run the following from this project folder:
+
+#+begin_src sh
+  SOLARPUNK_REPO=$PWD
+  MASTODON_REPO=$HOME/src/mastodon
+
+  cp -r $SOLARPUNK_REPO/* $MASTODON_REPO/
+  cp -r $SOLARPUNK_REPO/.env.production $MASTODON_REPO/
+#+end_src
+
+Should you have your mastodon checkout in a different location, set =MASTODON_REPO= to that location.
+
+** Build docker images
+
+After copying the files, we can build the docker images with:
+
+#+begin_src sh
+  cd $MASTODON_REPO
+  docker compose build
+#+end_src
+
+* WIP Running mastodon
+
+To run the instance, follow these steps:
+
+*Going to need vv to fill this part out.*
+
+** TODO Set up external networks
+
+** TODO Set up reverse proxy
+
+** TODO Set up cert-bot
+
+** TODO Run containers