Show / Hide Table of Contents

    Setup

    1. Install Visual Studio 2019. Make sure to install support for .Net Framework 4.7 development.
    2. Clone the repo git clone git@github.com:dsafa/audio-band.git
    3. Open the solution file under src/AudioBand.sln in visual studio.
    4. Restore nuget packages before building
    5. The toolbar will have to be installed after being built (see Running local version section).
    Note

    Explorer does not unload audioband so you will not be able to build if explorer has loaded it. The debug configuration will automatically attempt close explorer to build the audioband project and restart it after the build.

    Running local version

    To test the local version of audioband, it needs to be installed as a toolbar. The easiest way is to copy the install script from tools/install.cmd to the build output folder and run it as admin.

    Warning

    Installing the development version will overwrite any other installations.

    Debugging

    There are 2 ways you can use a debugger on audioband.

    • Attach the debugger: In visual studio, open the attach to process menu (ctrl + alt + p). Select explorer.exe and click attach.
    • Inserting the statement System.Diagnostics.Debugger.Launch(); will allow you to attach a debugger at any place in the code. This is useful if you need the debugger at the start.

    Running unit tests

    You may notice that there is a configuration called Test. This is so that it is easier to run tests without having to restart explorer to build the project. Since the dlls will be in use by explorer, switching to the test configuration allows the project to be built. Otherwise, it should be identical to the debug configuration.

    Tests are located under the tests folder in the solution.

    • Improve this Doc
    Back to top Generated by DocFX