From 6866ff7f4bf59b8782c9bd55a343737be3377aab Mon Sep 17 00:00:00 2001 From: Vincent Sonnier Date: Sat, 19 May 2018 16:00:27 +0200 Subject: [PATCH] Consistent formatting for files + paths --- Build-Windows.md | 68 ++++++++++++++++++++++++------------------------ 1 file changed, 34 insertions(+), 34 deletions(-) diff --git a/Build-Windows.md b/Build-Windows.md index ebfae50..4e3984d 100644 --- a/Build-Windows.md +++ b/Build-Windows.md @@ -19,9 +19,9 @@ During installation with the 'Visual Studio Installer' make sure you select at l # Build wxWidgets -Download https://github.com/wxWidgets/wxWidgets/releases/download/v3.1.1/wxWidgets-3.1.1.zip and unzip it to somewhere such as C:\MSVCDev\wxWidgets-3.1.1\ +Download https://github.com/wxWidgets/wxWidgets/releases/download/v3.1.1/wxWidgets-3.1.1.zip and unzip it to somewhere such as `C:\MSVCDev\wxWidgets-3.1.1` -Navigate to C:\MSVCDev\wxWidgets-3.1.1\build\msw\ (or wherever you extracted) and open wx_vc15.sln. +Navigate to `C:\MSVCDev\wxWidgets-3.1.1\build\msw` (or wherever you extracted) and open `wx_vc15.sln`. Choose `Release` and `x64` for the build configuration and "Build Solution". All *should* compile successfully and you can close the project. This configuration effectively builds wxWidgets as a static library, later linked with CubicSDR. @@ -40,10 +40,10 @@ As recommended, uninstall the older CMake version first if present, then just in # Install SoapySDR -Download ZIP or clone SoapySDR from https://github.com/pothosware/SoapySDR to C:\MSVCDev\SoapySDR +Download ZIP or clone SoapySDR from https://github.com/pothosware/SoapySDR to `C:\MSVCDev\SoapySDR` -* Launch CMake, set source path to C:/MSVCDev/SoapySDR/ -* Set destination to C:/MSVCDev/SoapySDR_win64/ +* Launch CMake, set source path to `C:/MSVCDev/SoapySDR/` +* Set destination to `C:/MSVCDev/SoapySDR_win64/` * Click "Configure" and choose "Visual Studio 15 2017 Win64" and Finish * Click "Generate" @@ -67,14 +67,14 @@ Update your system environment variables (Search "enviornment variables" in wind # Build CubicSDR: -* Clone or download ZIP from https://github.com/cjcliffe/CubicSDR/ to C:\MSVCDev\CubicSDR +* Clone or download ZIP from https://github.com/cjcliffe/CubicSDR/ to `C:\MSVCDev\CubicSDR` * Run CMake GUI -* Choose C:\MSVCDev\CubicSDR for source. -* Choose C:\MSVCDev\CubicSDR_win64 for build folder. +* Choose `C:\MSVCDev\CubicSDR` for source. +* Choose `C:\MSVCDev\CubicSDR_win64` for build folder. * Click Configure. * Choose "Visual Studio 15 2017 Win64" and Finish. -* Set wxWidgets_ROOT_DIR to "C:\MSVCDev\wxWidgets-3.1.1". -* Set wxWidgets_LIB_DIR to "C:\MSVCDev\wxWidgets-3.1.1\lib\vc_x64_lib". +* Set wxWidgets_ROOT_DIR to `C:\MSVCDev\wxWidgets-3.1.1`. +* Set wxWidgets_LIB_DIR to `C:\MSVCDev\wxWidgets-3.1.1\lib\vc_x64_lib`. Configure variables to indicate CubicSDR that modules files will be searched in the `[CubicSDR executable]\modules` directory: @@ -82,9 +82,9 @@ Configure variables to indicate CubicSDR that modules files will be searched in * Set BUNDLE_SOAPY_MODS to 1 (selected) * Set BUNDLED_MODS_ONLY to 1 (selected) * Click Configure again, all should be good, then Generate. -* Navigate to C:\MSVCDev\CubicSDR_win64\ in explorer and open CubicSDR.sln. +* Navigate to `C:\MSVCDev\CubicSDR_win64` in explorer and open `CubicSDR.sln`. - Once open select "Release" and "x64" build configuration and then "Build Solution" (F6) -- CubicSDR.exe should now be in the output folder (i.e. C:\MSVCDev\CubicSDR_win64\x64\) and ready to run (minus support modules). +- CubicSDR.exe should now be in the output folder (i.e. `C:\MSVCDev\CubicSDR_win64\x64`) and ready to run (minus support modules). # Build Support Modules and dependencies @@ -109,28 +109,28 @@ C:\MSVCDev\pthreads-win32\include\*.h C:\MSVCDev\pthreads-win32\dll\x64\pthreadVC2.dll ```` -Copy the file `pthreadVC2.dll` in the `C:\MSVCDev\CubicSDR_win64\x64\` directory where CubicSDR can find it. +Copy the file `pthreadVC2.dll` in the `C:\MSVCDev\CubicSDR_win64\x64` directory where CubicSDR can find it. ### libusb Easiest way: use a pre-compiled `librtlsdr` binary which also package `libusb` from the [librtlsdr Releases](https://github.com/librtlsdr/librtlsdr/releases) page and choose the "x64" version. Or compile it from source: -* Clone or download https://github.com/libusb/libusb to C:\MSVCDev\libusb +* Clone or download https://github.com/libusb/libusb to `C:\MSVCDev\libusb` * Build it using `C:\MSVCDev\libusb\msvc\libusb_2017.sln` choosing the `Release` and `x64` configuration. -Copy the file `libusb-1.0.dll` in the `C:\MSVCDev\CubicSDR_win64\x64\` directory where CubicSDR can find it. +Copy the file `libusb-1.0.dll` in the `C:\MSVCDev\CubicSDR_win64\x64` directory where CubicSDR can find it. ### librtlsdr -* Clone or download https://github.com/librtlsdr/librtlsdr to C:\MSVCDev\librtlsdr -* Launch CMake, set source path to C:/MSVCDev/librtlsdr/ -* Set destination to C:/MSVCDev/librtlsdr_win64/ +* Clone or download https://github.com/librtlsdr/librtlsdr to `C:\MSVCDev\librtlsdr` +* Launch CMake, set source path to `C:/MSVCDev/librtlsdr/` +* Set destination to `C:/MSVCDev/librtlsdr_win64/` * Click "Configure" and choose "Visual Studio 15 2017 Win64" and Finish -* Set LIBUSB_INCLUDE_DIR to C:/MSVCDev/libusb/ -* Set LIBUSB_LIBRARIES to C:/MSVCDev/libusb/x64/Release/dll/libusb-1.0.lib -* Set THREADS_PTHREADS_INCLUDE_DIR to C:/MSVCDev/pthreads-win32/include -* Set THREADS_PTHREADS_WIN32_LIBRARY to C:/MSVCDev/pthreads-win32/lib/x64/pthreadVC2.lib +* Set LIBUSB_INCLUDE_DIR to `C:/MSVCDev/libusb/` +* Set LIBUSB_LIBRARIES to `C:/MSVCDev/libusb/x64/Release/dll/libusb-1.0.lib` +* Set THREADS_PTHREADS_INCLUDE_DIR to `C:/MSVCDev/pthreads-win32/include` +* Set THREADS_PTHREADS_WIN32_LIBRARY to `C:/MSVCDev/pthreads-win32/lib/x64/pthreadVC2.lib` * Click "Configure" again and then click "Generate" Open "Developer Command Prompt for VS2017" by right-clicking and "Run as Administrator". @@ -144,16 +144,16 @@ C:\MSVCDEV> cmake --build librtlsdr_win64 --config Release --target install 0 Error(s) ``` -Copy the file `rtlsdr.dll` in the `C:\MSVCDev\CubicSDR_win64\x64\` directory where CubicSDR can find it. +Copy the file `rtlsdr.dll` in the `C:\MSVCDev\CubicSDR_win64\x64` directory where CubicSDR can find it. ## SoapyRTLSDR -* Clone or download ZIP from https://github.com/pothosware/SoapyRTLSDR to C:\MSVCDev\SoapyRTLSDR -* Launch CMake, set source path to C:/MSVCDev/SoapyRTLSDR/ -* Set destination to C:/MSVCDev/SoapyRTLSDR_win64/ +* Clone or download ZIP from https://github.com/pothosware/SoapyRTLSDR to `C:\MSVCDev\SoapyRTLSDR` +* Launch CMake, set source path to `C:/MSVCDev/SoapyRTLSDR/` +* Set destination to `C:/MSVCDev/SoapyRTLSDR_win64` * Click "Configure" and choose "Visual Studio 15 2017 Win64" and Finish -* Set RTLSDR_INCLUDE_DIR to C:/MSVCDev/librtlsdr/include -* Set RTLSDR_LIBRARY to C:/MSVCDev/librtlsdr_win64/src/Release/rtlsdr.lib +* Set RTLSDR_INCLUDE_DIR to `C:/MSVCDev/librtlsdr/include` +* Set RTLSDR_LIBRARY to `C:/MSVCDev/librtlsdr_win64/src/Release/rtlsdr.lib` * Click "Configure" again and then click "Generate" Open "Developer Command Prompt for VS2017" by right-clicking and "Run as Administrator". @@ -172,13 +172,13 @@ Copy the generated module file `rtlsdrSupport.dll` in the `C:\MSVCDev\CubicSDR_w * Clone or download ZIP from https://github.com/pothosware/SoapySDRPlay to C:\MSVCDev\SoapySDRPlay * Download "API/HW Driver" from https://www.sdrplay.com/downloads/ and install it with defaults. -* Launch CMake, set source path to C:/MSVCDev/SoapySDRPlay / -* Set destination to C:/MSVCDev/SoapySDRPlay_win64/ +* Launch CMake, set source path to `C:/MSVCDev/SoapySDRPlay` +* Set destination to `C:/MSVCDev/SoapySDRPlay_win64` * Click "Configure" and choose "Visual Studio 15 2017 Win64" and Finish -* Set LIBSDRPLAY_INCLUDE_DIRS to C:/Program Files/SDRplay/API/inc -* Set LIBSDRPLAY_LIBRARIES to C:/Program Files/SDRplay/API/x64/mir_sdr_api.lib -* Set SOAPY_SDR_INCLUDE_DIR to C:/MSVCDev/SoapySDR/include -* Set SOAPY_SDR_LIBRARY to C:/MSVCDev/SoapySDR_win64/lib/Release/SoapySDR.lib +* Set LIBSDRPLAY_INCLUDE_DIRS to `C:/Program Files/SDRplay/API/inc` +* Set LIBSDRPLAY_LIBRARIES to `C:/Program Files/SDRplay/API/x64/mir_sdr_api.lib` +* Set SOAPY_SDR_INCLUDE_DIR to `C:/MSVCDev/SoapySDR/include` +* Set SOAPY_SDR_LIBRARY to `C:/MSVCDev/SoapySDR_win64/lib/Release/SoapySDR.lib` * Click "Configure" again and then click "Generate" Open "Developer Command Prompt for VS2017" by right-clicking and "Run as Administrator".