Updated README and SDL html docs
This commit is contained in:
parent
607ca6fe29
commit
0b4ab1a0b9
12
README
12
README
|
@ -24,7 +24,9 @@ Table of Contents
|
|||
----------------
|
||||
* sdl2 - Version >= 2.0 (sdl2 >= 2.8 recommended)
|
||||
* cmake - Required to build fceux.
|
||||
* qt5 OR qt6 - (qt version >= 5.11 recommended) (Qt Modules Used: Widgets, OpenGL, and Help)
|
||||
* qt5 OR qt6 - (qt version >= 5.11 recommended)
|
||||
- Required Qt Modules: Widgets and OpenGL
|
||||
- Optional Qt Modules: Help
|
||||
* liblua5.1 (optional) - Will statically link internally if the system cannot provide this.
|
||||
* libx264 (optional) - H.264 video encoder for avi recording (recommended)
|
||||
* libx265 (optional) - H.265 video encoder for avi recording (recommended)
|
||||
|
@ -95,6 +97,14 @@ OpenGL options:
|
|||
For Linux builds, the OpenGL library preference can be either GLVND or LEGACY (default).
|
||||
To use GLVND OpenGL, add a -DGLVND=1 on the cmake command line.
|
||||
|
||||
Qt Help Engine options:
|
||||
The GUI supports both online and offline documentation options.
|
||||
Online documentation requires an internet connection and a browser.
|
||||
Qt supports an help engine that can read compiled html files (made via the Qt qhelpgenerator tool),
|
||||
these files can reside locally on ones computer and be accessed by the GUI using the Qt help engine module.
|
||||
The Qt help engine is an optional dependency and can be enabled in the build by
|
||||
adding a -DQHELP=1 on the cmake command line.
|
||||
|
||||
Qt Styling Options:
|
||||
The Qt GUI can use custom Qt widget styling by providing it a Qt stylesheet file.
|
||||
Use the GUI config window to set style options.
|
||||
|
|
|
@ -191,15 +191,7 @@ necessarily 100% accurate or complete):
|
|||
<p>
|
||||
The Qt GUI can either use the standard system style/themes or custom stylesheets.
|
||||
The available standard styles that are installed on the system will be listed when running the executable command line help.
|
||||
To use a provided system style, use the --style command line argument.
|
||||
To use a custom Qt stylesheet file, set an environment variable named FCEUX_QT_STYLESHEET that contains
|
||||
the full path to the file. This will check for this at startup.
|
||||
If the variable is defined and the file is readable by the program,
|
||||
then the styling settings will be used by the GUI.<br>
|
||||
<br>Bash Shell Setup Example:
|
||||
<pre>
|
||||
export FCEUX_QT_STYLESHEET=/home/me/myFceux.qss
|
||||
</pre>
|
||||
To use a provided system style or a custom Qt stylesheet file, make the proper selections in the Qt GUI config subwindow.<br>
|
||||
For information on Qt stylesheet syntax, see <a href=https://doc.qt.io/>Qt online documentation</a>
|
||||
</p>
|
||||
<a name="using-hotkeys"><h3>Hotkey Assignments</h3></a>
|
||||
|
|
Loading…
Reference in New Issue