home *** CD-ROM | disk | FTP | other *** search
/ ftp.lokigames.com / ftp.lokigames.com.zip / ftp.lokigames.com / open-source / loki_patch / README < prev    next >
Text File  |  2001-01-17  |  3KB  |  104 lines
  1.  
  2. Loki Patch Tools 1.0
  3.  
  4.  
  5. Introduction
  6. ============
  7. This is a set of tools written by Loki Software, Inc., designed to
  8. create a set of binary patches that can be easily used either by
  9. themselves or in conjunction with the Loki Update Tool.
  10.  
  11.  
  12. Licensing
  13. =========
  14. This update tool is available for use under the GNU General Public License.
  15.  
  16.  
  17. How To Create A Patch
  18. =====================
  19.  
  20.  * Create a directory for your patch source files:
  21.  
  22.      mkdir upgrade
  23.      cd upgrade
  24.  
  25.  * Create binary and data directories for the original files. e.g: 
  26.  
  27.      mkdir bin-1.54a-x86 data-1.54a
  28.  
  29.  * Create binary and data directories for the new files, e.g: 
  30.  
  31.      mkdir bin-1.54b-x86 data-1.54b
  32.  
  33.  * Copy the appropriate files into the directories, e.g.: 
  34.  
  35.     cp /usr/local/games/rt2.old/rt2 bin-1.54a-x86/rt2
  36.     cp /usr/local/games/rt2.new/rt2 bin-1.54b-x86/rt2
  37.  
  38.     cp /usr/local/games/rt2.old/default2.lng data-1.54a/
  39.     cp /usr/local/games/rt2.new/default2.lng data-1.54b/
  40.  
  41.  * Copy the patch README into the new data directory, e.g: 
  42.  
  43.     cp /usr/local/games/rt2.new/README-1.54b data-1.54b/README-1.54b
  44.  
  45.  * Copy the patch tools image directory to a new patch directory tree, e.g: 
  46.  
  47.     cp -av ~/loki_patch/image rt2-1.54b-x86
  48.  
  49.  * Generate deltas of the binaries and data files. 
  50.  
  51.      make_patch rt2-1.54b-x86/patch.dat delta-install bin-1.54a-x86 bin-1.54b-x86
  52.      make_patch rt2-1.54b-x86/patch.dat delta-install data-1.54a-x86 data-1.54b-x86
  53.  
  54.    The make_patch tool is very flexible, run it without any options to see a list of commands that it recognizes. 
  55.  
  56.  * Customize the patch description file, patch.dat, if necessary, e.g.
  57.  
  58.      vi rt2-1.54b-x86/patch.dat
  59.  
  60.  * Copy the README into the patch directory, e.g: 
  61.  
  62.      cp data-1.54b/README-1.54b rt2-1.54b-x86/README.txt
  63.  
  64.    This file is shown to the user before they apply the patch. 
  65.  
  66.  * Pack the patch archive, e.g: 
  67.  
  68.      makeself.sh rt2-1.54b-x86 rt2-1.54b-x86.run "Railroad Tycoon II 1.54b update" ./apply-patch.sh
  69.  
  70.  * Test the patch on a fresh install, e.g: 
  71.  
  72.      # remove old versions, install from CD, patch up to current level
  73.      sh rt2-1.54b-x86.run
  74.  
  75.  * Generate the GPG signature, named patch.sig, e.g: 
  76.  
  77.      gpg --secret-keyring /mnt/cdrom/secring.gpg --detach-sign rt2-1.54b-x86.run
  78.  
  79.  * Generate the MD5 checksum, named patch.md5, e.g: 
  80.  
  81.      md5sum rt2-1.54b-x86.run >rt2-1.54b-x86.run.md5
  82.  
  83.  * Generate the README, named patch.txt, e.g: 
  84.  
  85.      cp rt2-1.54b-x86/README.txt rt2-1.54b-x86.run.txt
  86.  
  87.  * Generate the Loki Update Tool entry for the patch, e.g:
  88.  
  89.      loki_patch --info rt2-1.54b-x86/patch.dat >>updates.txt
  90.  
  91.  * Copy the patch to your public relase directory and you're done!
  92.  
  93.  
  94. Feedback
  95. ========
  96. You can send feedback to setup@lokigames.com, or join the fun on the
  97. Loki Setup newsgroup: news://news.lokigames.com/loki.open-source.setup
  98.  
  99.  
  100. Author
  101. ======
  102. The Loki Patch Tools were written by Sam Lantinga at Loki Software, Inc.
  103.  
  104.