From 8994ac50b0222bc1a2ad693c62fa61fd3e6efd77 Mon Sep 17 00:00:00 2001 From: Brendan Hagan Date: Tue, 12 Jul 2022 20:22:08 -0400 Subject: [PATCH] misc: revert installation instruction changes, modify readme formatting --- README.md | 27 ++++++++++++++++++++------- 1 file changed, 20 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index ccd76970..abef17ad 100644 --- a/README.md +++ b/README.md @@ -18,16 +18,18 @@ On windows, the program can be compiled with Visual Studio (recommended) or with * Download and install [Visual Studio Community edition](https://visualstudio.microsoft.com/vs/community/) * Download and install [vcpkg](https://github.com/microsoft/vcpkg) * Use vcpkg to install wxwidgets, boost, hunspell + ```` -vcpkg install wxwidgets:x86-windows-static -vcpkg install boost-smart-ptr:x86-windows-static -vcpkg install boost-regex:x86-windows-static -vcpkg install boost-logic:x86-windows-static -vcpkg install boost-pool:x86-windows-static -vcpkg install boost-iterator:x86-windows-static -vcpkg install hunspell:x86-windows-static +vcpkg install wxwidgets +vcpkg install boost-smart-ptr +vcpkg install boost-regex +vcpkg install boost-logic +vcpkg install boost-pool +vcpkg install boost-iterator +vcpkg install hunspell vcpkg integrate install ```` + * Then just use "Open Folder" from inside visual studio to open the Magic Set Editor source code root folder. * Select the configuration that you want to build, and hit F7. @@ -44,6 +46,7 @@ The tests can be run from inside visual studio * Download and install [msys2](https://www.msys2.org/) * Install a recent version of the gcc compiler, cmake, and wxWidgets libraries: + ```` pacman -S mingw32/mingw-w64-i686-gcc pacman -S mingw32/mingw-w64-i686-wxWidgets @@ -51,8 +54,10 @@ pacman -S mingw32/mingw-w64-i686-boost pacman -S mingw32/mingw-w64-i686-hunspell pacman -S cmake ```` + Use `mingw64/mingw-w64-x86_64-...` instead of for the 64bit build * Build + ```` cmake -G "MSYS Makefiles" -H. -Bbuild -DCMAKE_BUILD_TYPE=Release cmake --build build @@ -65,29 +70,37 @@ Install the dependencies, for example on a debian based system sudo apt install g++ sudo apt install libboost-dev libwxgtk3.0-gtk3-dev libhunspell-dev ```` + Then use cmake to build + ```` cmake build -DCMAKE_BUILD_TYPE=Release cmake --build build ```` + Use `CMAKE_BUILD_TYPE=Debug` for a debug build ## Building on Mac Install the dependencies, for example using Homebrew + ```` brew install boost wxwidgets hunspell ```` + Note: Tested with boost 1.72.0_3, wxmac (wxwidgets) 3.0.5.1_1, hunspell 1.7.0_2 Then use cmake to build + ```` mkdir build && cd build cmake -DCMAKE_BUILD_TYPE=Release .. cmake --build .. ```` + Use `CMAKE_BUILD_TYPE=Debug` for a debug build Finally, copy the resources to a SharedSupport directory and run the executable + ```` mkdir SharedSupport && cd SharedSupport cp -r ../resource SharedSupport/