website readme

tipsy · tipsy · commit c4f2429ec1ff · 2021-06-12T22:45:00.000+02:00
diff --git a/docs/README b/docs/README
@@ -0,0 +1,3 @@
+# j2html.com
+
+Don't edit these files manually, they are generated from `j2html/website`.
diff --git a/website/README b/website/README
@@ -0,0 +1,21 @@
+# j2html.com source code
+
+## Running
+
+Run this as any maven project.
+Website is available on http://localhost:8888/.
+
+## Deploying
+
+In order to "deploy" the website, the static files in the `j2html/docs` must be updated.
+You can either download the files manually from your browser, or use curl:
+
+```
+curl "http://localhost:8888/" > index.html
+curl "http://localhost:8888/download.html" > download.html
+curl "http://localhost:8888/examples.html" > examples.html
+curl "http://localhost:8888/news.html" > news.html
+curl "http://localhost:8888/404.html" > 404.html
+```
+
+Changes will be deployed automatically once they have been merged.

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# j2html.com`
	`2`	`+`
	`3`	+Don't edit these files manually, they are generated from `j2html/website`.