aboutsummaryrefslogtreecommitdiff
path: root/docs/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 000000000..050eefc37
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,13 @@
+This is the documentation deployed by GitHub Pages.
+
+To build and serve locally, first install the necessary packages:
+```sh
+bundle install
+```
+
+Then serve:
+```sh
+bundle exec jekyll serve -H 127.0.0.1 --watch --incremental
+```
+
+The documentation should be reachable at <http://127.0.0.1:4000/FreshRSS/>.