1 files changed, 35 insertions, 0 deletions
diff --git a/README.hosting.md b/README.hosting.md
new file mode 100644
index 0000000..c06c066
--- /dev/null
+++ b/README.hosting.md
@@ -0,0 +1,35 @@
+# About this website
+
+This website was built using the Swimmer network tile tool. These are generic instructions for a website developed using this tool.
+
+## Structure
+
+This folder contains the Javascript application, some metadata, and then a set of index.html files which load the application so you can deep-link to a specific page.
+
+- `graph_name/` - the root folder
+- `graph_name/index.html` - the expected starting page
+- `graph_name/index.json` - the site data containing the graph of all pages and tiles
+- `graph_name/bundle.js` - the Javascript application
+- `graph_name/bundle.js.map` - the Javascript source map
+- `graph_name/static/` - static assets, including any media that has been directly included with the project
+- `graph_name/[page_name]/index.html` - basic index pages following the graph structure which simply load the application
+
+## Deploying
+
+This website is intended to be run fully static from the root folder of a web server. It should be completely self-contained, with the exception of any externally hosted assets that may be linked in the metadata.
+
+## Testing
+
+Open a terminal and `cd` to one folder up from this one, and then run:
+
+```bash
+python3 -m http.server 8000
+```
+
+The server will be running on http://0.0.0.0:8000/ - you can just add the name of this folder to the URL to view the site.
+
+## Credit
+
+Built by Jules LaPlace, 2020.
+
+https://asdf.us/