Early firmware update support

[gamestick-pjgsapi.git] / README.rst

diff --git a/README.rst b/README.rst
index 8b5ae01d9e4128586dfeba8bb798ea4e6622cb79..a71e12f1654847e7b6330987bdfb8dec40c9f5cb 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -14,19 +14,27 @@ Setup
      $ git clone https://codeberg.org/gamestick-fans/game-data.git
 3. Unpack one of the cache files::
 
-     $ cd game-data
-     $ gunzip -k caches/2017-01-12T00\:19\:12-alex.shorts.pretty.json.gz
-4. Generate the popular and featured menus from the cache file::
+     $ gunzip -k game-data/caches/2017-01-12T00\:19\:12-alex.shorts.pretty.json.gz
+4. Generate the popular and featured menus from the cache file,
+   and extract the translation strings::
 
-     $ ./bin/list-popular.php 'caches/2017-01-12T00:19:12-alex.shorts.pretty.json' > ../cache/popular.txt
-     $ ./bin/list-featured.php 'caches/2017-01-12T00:19:12-alex.shorts.pretty.json' > ../cache/featured.json
+     $ ./bin/exract-all.sh 'game-data/caches/2017-01-12T00:19:12-alex.shorts.pretty.json'
 5. Fill the caches for this API::
 
-     $ cd ..
      $ ./bin/generate-apps-cache.php game-data/classic/
 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/>`_