Updated documentation for new Qt GUI AVI recording capabiliity.

This commit is contained in:
mjbudd77 2021-05-02 18:51:10 -04:00
parent 6283dc4687
commit a74c2ae80b
4 changed files with 25 additions and 0 deletions

1
README
View File

@ -26,6 +26,7 @@ Table of Contents
* cmake - Required to build fceux. * cmake - Required to build fceux.
* qt5 OR qt6 - (qt version >= 5.11 recommended) * qt5 OR qt6 - (qt version >= 5.11 recommended)
* liblua5.1 (optional) - Will statically link internally if the system cannot provide this. * liblua5.1 (optional) - Will statically link internally if the system cannot provide this.
* libx264 (optional) - H.264 video encoder for avi recording
* minizip * minizip
* zlib * zlib
* openGL * openGL

View File

@ -1,3 +1,25 @@
/* FCE Ultra - NES/Famicom Emulator
*
* Copyright notice for this file:
* Copyright (C) 2020 mjbudd77
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
//
// AviRecord.cpp
//
#include <stdio.h> #include <stdio.h>
#include <stdlib.h> #include <stdlib.h>
#include <stdint.h> #include <stdint.h>

View File

@ -61,6 +61,7 @@
<li><a href="https://cmake.org/">Cmake is required to build from source.</a></li> <li><a href="https://cmake.org/">Cmake is required to build from source.</a></li>
<li>Cross platform Qt GUI replaces deprecated GTK GUI</li> <li>Cross platform Qt GUI replaces deprecated GTK GUI</li>
<li>Requires Qt5, SDL2, minizip, zlib, and OpenGL</li> <li>Requires Qt5, SDL2, minizip, zlib, and OpenGL</li>
<li>libx264 is an optional dependency that provides H.264 video encoding for AVI recording</li>
<li>Lua 5.1 is optional, if the system cannot provide this, an internal version of Lua will be statically linked</li> <li>Lua 5.1 is optional, if the system cannot provide this, an internal version of Lua will be statically linked</li>
<li>The Qt GUI is required and will automatically be part of the build.</li> <li>The Qt GUI is required and will automatically be part of the build.</li>
<li>For installation instructions on Linux systems, see the README at the root level of the source tree</li> <li>For installation instructions on Linux systems, see the README at the root level of the source tree</li>

View File

@ -81,6 +81,7 @@
brew install qt5 brew install qt5
brew install sdl2 brew install sdl2
brew install minizip brew install minizip
brew install libx264 (optional dependency but recommended for AVI recording)
</pre> </pre>
Otherwise you can install the dmg packages available from the Qt and SDL websites. Otherwise you can install the dmg packages available from the Qt and SDL websites.
<br><br>The following tools are required to build from source: <br><br>The following tools are required to build from source: