Building on Windows

Supported MVSC Version

Snow Crash officially supports Microsoft Visual C++ 2013 or higher.

Build Snow Crash

1. Install Visual Studio Express for Windows Desktop

2. Install Python 2.7

3. Install Git

4. Clone apiaryio/snowcrash recursively using GitHub client or git clone --recursive in the Git Shell

5. Open Command Prompt and change directory (cd) to Snow Crash e.g.:

    > z:
    > cd Apiary\snowcrash
   

6. Run vcbuild.bat:

    > vcbuild.bat
   

7. Run Snow Crash tests:

    > vbuild.bat test
   

8. Run Snow Crash integration tests (optional)

    > vbuild.bat inttest
   

Visual Studio Solution File

Running vcbuild.bat (step 6) also generates the Snow Crash MSVS solution file - snowcrash.sln. You can find it inside the snowcrash/build directory and open it with your Visual Studio.

Older Versions of Visual Studio

You can control the version of MSVS solution file generated by specifying a MSVC20XX flag while invoking the vcbuild.bat. Run vcbuild.bat /? to see the list of supported MSVC versions.

Snow Crash Integration Tests

Snow Crash integrations tests are done using Cucumber and Aruba. You can find the tests features in the features directory.

In order to run the tests you need to have Ruby and Bundle gem installed on your systems:

1. Install Ruby 1.9.3-p545 (check Add Ruby executable to your PATH on the installation)

2. Update RubyGems

3. Use Command Prompt to install the Bundle gem

    > gem install bundle
   

4. Run the integration tests

    > vbuild.bat inttest
   

Note: You can use ansicon to enhance Cucumber output in the Command Prompt.

Note: If you are running the tests manually using bundle exec cucumber make sure to set ENV['PATH'] to include the directory with snowcrash.exe (done automatically using vcbuild.bat inttest).