From 1f226ec14ff5d0fe30d5e328ec9854b1967a3ab9 Mon Sep 17 00:00:00 2001 From: Ryan Meredith Date: Sun, 19 Nov 2017 16:11:33 -0500 Subject: [PATCH] Update Readme.md and various fixes --- CMake/DolphinCompileDefinitions.cmake | 2 +- Readme.md | 9 ++++++--- .../Config/Graphics/SoftwareRendererWidget.cpp | 6 +++--- .../DolphinQt2/Config/Graphics/SoftwareRendererWidget.h | 2 +- Source/Core/DolphinWX/Config/WiiConfigPane.cpp | 2 +- Source/Core/DolphinWX/SoftwareVideoConfigDialog.cpp | 4 ++-- Source/Core/UICommon/CommandLineParse.cpp | 2 +- 7 files changed, 15 insertions(+), 12 deletions(-) diff --git a/CMake/DolphinCompileDefinitions.cmake b/CMake/DolphinCompileDefinitions.cmake index d150cb535c..3818ded0df 100644 --- a/CMake/DolphinCompileDefinitions.cmake +++ b/CMake/DolphinCompileDefinitions.cmake @@ -1,4 +1,4 @@ -# Add a C or C++ compile definitions to the current scope +# Add C or C++ compile definitions to the current scope # # dolphin_compile_definitions(def [def ...] [DEBUG_ONLY | RELEASE_ONLY]) # diff --git a/Readme.md b/Readme.md index edde8536f3..549fc5f37e 100644 --- a/Readme.md +++ b/Readme.md @@ -43,6 +43,9 @@ Visual Studio 2017 is a hard requirement. Other compilers might be able to build Dolphin on Windows but have not been tested and are not recommended to be used. Git and Windows 10 SDK 10.0.15063.0 must be installed when building. +The "Release" solution configuration includes performance optimizations for the best user experience but complicates debugging Dolphin. +The "Debug" solution configuration is significantly slower, more verbose and less permissive but makes debugging Dolphin easier. + An installer can be created by using the `Installer.nsi` script in the Installer directory. This will require the Nullsoft Scriptable Install System (NSIS) to be installed. Creating an installer is not necessary to run Dolphin @@ -125,9 +128,9 @@ see where it's stored) if you don't plan to reinstall Dolphin. `Usage: Dolphin [-h] [-d] [-l] [-e ] [-b] [-V ] [-A ]` * -h, --help Show this help message -* -d, --debugger Opens the debugger -* -l, --logger Opens the logger -* -e, --exec= Loads the specified file (DOL,ELF,WAD,GCM,ISO) +* -d, --debugger Show the debugger pane and additional View menu options +* -l, --logger Open the logger +* -e, --exec= Load the specified file (DOL,ELF,WAD,GCM,ISO) * -b, --batch Exit Dolphin with emulator * -V, --video_backend= Specify a video backend * -A, --audio_emulation= Low level (LLE) or high level (HLE) audio diff --git a/Source/Core/DolphinQt2/Config/Graphics/SoftwareRendererWidget.cpp b/Source/Core/DolphinQt2/Config/Graphics/SoftwareRendererWidget.cpp index 24e0d77836..68116b6379 100644 --- a/Source/Core/DolphinQt2/Config/Graphics/SoftwareRendererWidget.cpp +++ b/Source/Core/DolphinQt2/Config/Graphics/SoftwareRendererWidget.cpp @@ -49,9 +49,9 @@ void SoftwareRendererWidget::CreateWidgets() auto* overlay_box = new QGroupBox(tr("Overlay Information")); auto* overlay_layout = new QGridLayout(); overlay_box->setLayout(overlay_layout); - m_enable_statistics = new GraphicsBool(tr("Various Statistics"), Config::GFX_OVERLAY_STATS); + m_show_statistics = new GraphicsBool(tr("Show Statistics"), Config::GFX_OVERLAY_STATS); - overlay_layout->addWidget(m_enable_statistics); + overlay_layout->addWidget(m_show_statistics); auto* utility_box = new QGroupBox(tr("Utility")); auto* utility_layout = new QGridLayout(); @@ -162,6 +162,6 @@ void SoftwareRendererWidget::AddDescriptions() "this unchecked."); AddDescription(m_backend_combo, TR_BACKEND_DESCRIPTION); - AddDescription(m_enable_statistics, TR_SHOW_STATISTICS_DESCRIPTION); + AddDescription(m_show_statistics, TR_SHOW_STATISTICS_DESCRIPTION); AddDescription(m_dump_textures, TR_DUMP_TEXTURES_DESCRIPTION); } diff --git a/Source/Core/DolphinQt2/Config/Graphics/SoftwareRendererWidget.h b/Source/Core/DolphinQt2/Config/Graphics/SoftwareRendererWidget.h index 19d0918a63..f601604d74 100644 --- a/Source/Core/DolphinQt2/Config/Graphics/SoftwareRendererWidget.h +++ b/Source/Core/DolphinQt2/Config/Graphics/SoftwareRendererWidget.h @@ -29,7 +29,7 @@ private: void AddDescriptions(); QComboBox* m_backend_combo; - QCheckBox* m_enable_statistics; + QCheckBox* m_show_statistics; QCheckBox* m_dump_textures; QCheckBox* m_dump_objects; QCheckBox* m_dump_tev_stages; diff --git a/Source/Core/DolphinWX/Config/WiiConfigPane.cpp b/Source/Core/DolphinWX/Config/WiiConfigPane.cpp index cb8637cb46..f88d4be64d 100644 --- a/Source/Core/DolphinWX/Config/WiiConfigPane.cpp +++ b/Source/Core/DolphinWX/Config/WiiConfigPane.cpp @@ -88,7 +88,7 @@ void WiiConfigPane::InitializeGUI() "(576i) for PAL games.\nMay not work for all games.")); m_screensaver_checkbox->SetToolTip(_("Dims the screen after five minutes of inactivity.")); m_system_language_choice->SetToolTip(_("Sets the Wii system language.")); - m_sd_card_checkbox->SetToolTip(_("Saved to /Wii/sd.raw (default size is 128mb)")); + m_sd_card_checkbox->SetToolTip(_("Saved to /Wii/sd.raw (default size is 128mb).")); m_connect_keyboard_checkbox->SetToolTip(_("May cause slow down in Wii Menu and some games.")); m_bt_wiimote_motor_checkbox->SetToolTip(_("Enables Wii Remote vibration.")); diff --git a/Source/Core/DolphinWX/SoftwareVideoConfigDialog.cpp b/Source/Core/DolphinWX/SoftwareVideoConfigDialog.cpp index 76601ca2a9..8c44577dad 100644 --- a/Source/Core/DolphinWX/SoftwareVideoConfigDialog.cpp +++ b/Source/Core/DolphinWX/SoftwareVideoConfigDialog.cpp @@ -89,8 +89,8 @@ SoftwareVideoConfigDialog::SoftwareVideoConfigDialog(wxWindow* parent, const std group_info->Add(szr_info, 0, wxEXPAND | wxLEFT | wxRIGHT, space5); group_info->AddSpacer(space5); - szr_info->Add(new SettingCheckBox(page_general, _("Various Statistics"), "", - Config::GFX_OVERLAY_STATS)); + szr_info->Add( + new SettingCheckBox(page_general, _("Show Statistics"), "", Config::GFX_OVERLAY_STATS)); } // - utility diff --git a/Source/Core/UICommon/CommandLineParse.cpp b/Source/Core/UICommon/CommandLineParse.cpp index 683738479f..e2ca7038c0 100644 --- a/Source/Core/UICommon/CommandLineParse.cpp +++ b/Source/Core/UICommon/CommandLineParse.cpp @@ -95,7 +95,7 @@ std::unique_ptr CreateParser(ParserOptions options) parser->add_option("-d", "--debugger") .action("store_true") .help("Show the debugger pane and additional View menu options"); - parser->add_option("-l", "--logger").action("store_true").help("Opens the logger"); + parser->add_option("-l", "--logger").action("store_true").help("Open the logger"); parser->add_option("-b", "--batch").action("store_true").help("Exit Dolphin with emulation"); parser->add_option("-c", "--confirm").action("store_true").help("Set Confirm on Stop"); }