Early firmware update support

[gamestick-pjgsapi.git] / README.rst

diff --git a/README.rst b/README.rst
index 12d13d6246e39cf8597e6359c94fe8cec8812fcb..a71e12f1654847e7b6330987bdfb8dec40c9f5cb 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -25,6 +25,16 @@ Setup
 6. Setup the Apache web server and point the virtual host to the ``www/`` directory.
 
 
+Firmware updates
+================
+Firmware update diff files are needed.
+It is possible to send out full firmware files, but they
+will reset the user data.
+
+When you have such an update, put it into ``www/firmware/$version/update.img``
+and run ``./bin/prepare-firmware.sh www/firmware/$version/``.
+
+
 About
 =====
 This server software was written by `Christian Weiske <https://cweiske.de/>`_