From e10b9fb612ef334fe70bccc0f3169b5f8ac15482 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20Schl=C3=BCter?= <jan.schluter@lis-lab.fr> Date: Fri, 21 Dec 2018 11:53:46 +0100 Subject: [PATCH] Add installation instructions for Windows --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c52ff6f..1c53bd5 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,28 @@ cd src make ``` +### Under Windows +As for any other platform, there are multiple options on Windows. The following +has been tested successfully: Install CMake using the MSI installer from +https://cmake.org, install the Microsoft Visual Studio Build Tools from +https://aka.ms/buildtools (specifically, the C++ compiler), download and extract +the precompiled Windows binaries from https://libusb.info. Open the x64 Native +Tools Command Prompt and navigate to the source directory. Run the following: +``` +mkdir build +mkdir install +cd build +cmake .. -DLIBUSB_INCLUDE_DIR=<libusb_dir>/include -DLIBUSB_LIBRARY=<libusb_dir>/MS64/dll/libusb-1.0.lib -DCMAKE_INSTALL_PREFIX=../install +nmake +nmake install +``` +Replace `<libusb_dir>` with the path you extracted libusb to. If compilation and +installation succeeded, you will find a `jasonrec.exe` in `install/bin`. Copy +the `MS64/dll/libusb-1.0.dll` file from the libusb directory into `install/bin`. +You can now run `jasonrec.exe` from a command prompt, or by creating a shortcut +to it that includes suitable command line options. + + Usage ----- Running `jasonrec` without any arguments (or with any unsupported number of @@ -74,4 +96,3 @@ jasonrec 4 128000 %Y-%m-%d_%H-%M-%S.wav 300 ``` File names may also include directory names based on time stamps, but the directories have to be created in advance. - -- GitLab