cannonball: Adds a post install MESSAGE regarding configuration and manpage information.
authorSanthosh Raju <fox@NetBSD.org>
Tue, 22 Oct 2019 10:16:52 +0000 (05:16 -0500)
committerSanthosh Raju <fox@NetBSD.org>
Tue, 22 Oct 2019 10:16:52 +0000 (05:16 -0500)
cannonball/MESSAGE [new file with mode: 0644]

diff --git a/cannonball/MESSAGE b/cannonball/MESSAGE
new file mode 100644 (file)
index 0000000..95b750b
--- /dev/null
@@ -0,0 +1,18 @@
+===========================================================================
+$NetBSD$
+
+In order for CannonBall to work you need to provide a copy of the
+OutRun revision B romset to the roms subdirectory. Rename the files if
+necessary.
+
+The roms subdirectory can be found at $XDG_DATA_HOME/cannonball/roms
+which defaults to $HOME/.local/share/cannonball/roms
+
+Configuration can be found at $XDG_DATA_HOME/cannonball/config.xml
+which defaults to $HOME/.local/share/cannonball/config.xml
+
+NOTE: The directories will be created on the first run of CannonBall
+if they do not exist.
+
+NOTE: Refer cannonball(6) man page for more information.
+===========================================================================