Browse Source

Update REAMDE & configuration example

Yihua LOU 2 years ago
parent
commit
b78537e3b7
2 changed files with 17 additions and 15 deletions
  1. 5 5
      README.md
  2. 12 10
      sdlpal.cfg.example

+ 5 - 5
README.md

@@ -77,19 +77,19 @@ There are also solution files for building traditional **Windows (phone) store a
 To build SDLPAL as a Windows **desktop** app, you can also use ***MinGW***. Steps for building under MinGW varies depends on the compiling environment you have:
 
 * If you need to compile SDLPAL under **Windows** shell environment, please go to the root of the source code tree and type:
-```shell
-$ cd win32
-$ make -f Makefile.mingw
+```cmd
+C:\sdlpal> cd win32
+C:\sdlpal> make -f Makefile.mingw
 ```
 
 * If you need to compile SDLPAL under **msys** shell environment, please go to the root of the source code tree and type:
-```shell
+```bash
 $ cd win32
 $ make
 ```
 
 * If you need to cross-compile SDLPAL under **Linux** shell environment, please go to the root of the source code tree and type:
-```shell
+```bash
 $ cd win32
 $ # This builds a 32-bit executable.
 $ make HOST=i686-w64-mingw32-

+ 12 - 10
sdlpal.cfg.example

@@ -4,15 +4,6 @@
 # Lines started with '#' is treated as comments.    #
 #####################################################
 
-# CodePage: Indicates the codepage to use, 0 for big5 (default), 1 for gbk.
-#CodePage=0
-
-# UseEmbeddedFonts: Indicates whether to use DOS-version's embedded fonts.
-#                   Non-zero for using DOS-version's embedded fonts (default),
-#                   zero for using SDLPAL's internal fonts.
-# Note that this value is ignored when the DOS option is zero.
-#UseEmbeddedFonts=1
-
 # CD: Indicates which type of CD audio source to use. Valid types include 'RAW',
 #     'OGG' and 'MP3'. 'RAW' means use the SDL 1.2's CDAudio API (default when
 #     compiled with SDL 1.2), 'OGG' means use files named as '100xx.ogg' inside
@@ -25,7 +16,7 @@
 #        'MIDI' means midi (either in 'mus.mkf' or inside 'musics' directory),
 #        'OGG' means use files named as 'xx.ogg' inside the 'ogg' directory, while
 #        'MP3' means use files named as 'xx.mp3' inside the 'mp3' directory.
-#MUSIC=RIX
+#Music=RIX
 
 # OPL: Indicates which type of OPL emulator to use. Valid types include 'DOSBOX'
 #      (default), 'MAME' and 'DOSBOXNEW'. 'DOSBOXNEW' is the recommended OPL simulator
@@ -86,3 +77,14 @@
 
 # MessageFileName: Indicates whether to use external message files.
 #MessageFileName=jm.msg
+
+# FontFileName: Indicates whether to use external font files. Currently supports only BDF font.
+#FontFileName=jm.msg
+
+# LogLevel: This value controls how many logs can be output by the program. Valid ranges are:
+# 0 (Verbose), 1 (Debug), 2 (Informational), 3 (Warning), 4 (Error) and 5 (Fatal). Only logs
+# whose levels are larger or equal to this value can be output.
+#LogLevel=5
+
+# LogFileName: When set, the program's log will be output to this file as well.
+#LogFileName=sdlpal.log