addrom

commit 75a8f04cd07592a5e35e1c2fa3b4eef97c18dd18
parent f5422133fb8d9e6aa60a39d828a68b58644c2528
Author: Quentin Rameau <quinq@fifth.space>
Date:   Tue, 10 Nov 2015 13:11:55 +0100

Specify in doc that this tool do not work on all boxes

Diffstat:
README.md
 | 
4
+++-
addrom.1
 | 
9
++++++++-

2 files changed, 11 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
@@ -3,12 +3,14 @@ addrom
 
 Simple tool to add a rom entry to a PB3 list.dat.
 
-addrom lets you add a rom entry into a Pandora's Box v3 list.dat rom file.
+addrom lets you add a rom entry into a Pandora's Box 3 list.dat rom file.
 It reads an input file or starts from scratch, writes rom fields according the
 file format, calculates the total number of entries and modifies that reference
 in the file, and writes the resulting new file to the input file or another
 output file.
 
+Works only for Pandora's Box 3 520+20/540 in 1 (jamma).
+
 Installation
 ------------
 Edit config.mk for customizing compilation options and installation paths.
diff --git a/addrom.1 b/addrom.1
@@ -2,7 +2,7 @@
 .Dt ADDROM 1
 .Sh NAME
 .Nm addrom
-.Nd add a rom entry to a Pandora's Box v3 list.dat file
+.Nd add a rom entry to a Pandora's Box 3 list.dat file
 .Sh SYNOPSIS
 .Bk -words
 .Nm
@@ -58,3 +58,10 @@ overwritten).
 The name of the rom file, without file extention (ie. "wjammers").
 .Ek
 .El
+.Sh CAVEATS
+This tool will only work for the Pandora's Box 3 VGA/CGA "520+20" and "540"
+versions which use list.dat files. Other distributions like Little Elf 3 HD for
+example do not.
+.br
+Please contact the author if you have been able to use this tool for other
+versions of this system.