Skip to content

Commit

Permalink
Add a developer README
Browse files Browse the repository at this point in the history
  • Loading branch information
dechamps committed Jan 9, 2022
1 parent ad1721a commit a8c2466
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions src/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# WinSoftVol developer documentation

[![.github/workflows/continuous-integration.yml](https://github.com/dechamps/WinSoftVol/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/dechamps/WinSoftVol/actions/workflows/continuous-integration.yml)

WinSoftVol is designed to be built using CMake within the Microsoft Visual C++
2019 toolchain native CMake support.

Make sure to clone the Git repo *with submodules*.

You will need to have the [Windows Driver Kit][] installed. Any version will
likely work.

The build process also requires OpenSSL but that's only for driver signing
purposes. If you have [vcpkg][] set up, it will automatically build OpenSSL as a
dependency of WinSoftVol. Otherwise, you can manually provide `openssl.exe`;
just make sure it's somewhere CMake will find it.

With that out of the way, building WinSoftVol should be as simple as opening the
`src` folder in Visual Studio 2019 and hitting Build.

[vcpkg]: https://vcpkg.io/
[Windows Driver Kit]: https://docs.microsoft.com/en-us/windows-hardware/drivers/download-the-wdk

0 comments on commit a8c2466

Please sign in to comment.