From df43bd918bb38f3ae42a9ad8507c9aa96dafac55 Mon Sep 17 00:00:00 2001
From: Ian Renton <ian@ianrenton.com>
Date: Fri, 3 Oct 2025 14:31:05 +0100
Subject: [PATCH] README and main filename change

---
 .idea/runConfigurations/Run.xml |  2 +-
 README.md                       | 23 ++++++++++++++++++++++-
 main.py => spothole.py          |  0
 3 files changed, 23 insertions(+), 2 deletions(-)
 rename main.py => spothole.py (100%)

diff --git a/.idea/runConfigurations/Run.xml b/.idea/runConfigurations/Run.xml
index 47e9c8e..2d251ad 100644
--- a/.idea/runConfigurations/Run.xml
+++ b/.idea/runConfigurations/Run.xml
@@ -12,7 +12,7 @@
     <option name="IS_MODULE_SDK" value="true" />
     <option name="ADD_CONTENT_ROOTS" value="true" />
     <option name="ADD_SOURCE_ROOTS" value="true" />
-    <option name="SCRIPT_NAME" value="$PROJECT_DIR$/main.py" />
+    <option name="SCRIPT_NAME" value="$PROJECT_DIR$/spothole.py" />
     <option name="PARAMETERS" value="" />
     <option name="SHOW_COMMAND_LINE" value="false" />
     <option name="EMULATE_TERMINAL" value="false" />
diff --git a/README.md b/README.md
index 97ebe1e..7bd3a2f 100644
--- a/README.md
+++ b/README.md
@@ -20,10 +20,31 @@ TODO
 
 ### Running your own copy
 
-TODO
+To download and set up Spothole on a Debian server, run the following commands. Other operating systems will likely be similar.
+
+```bash
+git clone ssh://git@git.ianrenton.com/ian/spothole.git
+cd spothole
+python3 -m venv ./.venv
+source .venv/bin/activate
+pip install -r requirements.txt
+deactivate
+cp config-example.yml config.yml
+```
+
+Then edit `config.yml` in your text editor of choice to set up the software as you like it.
+
+Then, to run the software this time and any future times you want to run it directly from the command line:
+
+```bash
+source .venv/bin/activate
+python3 spothole.py
+```
 
 The software can take a few seconds to start up, mostly because it is downloading an updated file to match callsigns to countries. This is normal, don't panic!
 
+If you see some errors on startup, check your configuration, e.g. in case you have specified a port for the web server that is already in use by something else.
+
 ### Writing your own client
 
 TODO
diff --git a/main.py b/spothole.py
similarity index 100%
rename from main.py
rename to spothole.py