Skip to content

Latest commit

 

History

History
98 lines (64 loc) · 3.62 KB

README.md

File metadata and controls

98 lines (64 loc) · 3.62 KB
Raw

Arcana.cpp

Arcana is a collection of general purpose C++ utilities with no code that is specific to a particular project or specialized technology area, sort of like an extension to the STL. At present, the most notable of these utilities is the Arcana task library.

You can learn more about API usage in the arcana.cpp documentation.

Getting Started

  1. Clone the repo and checkout the master branch.
  2. Arcana depends on GSL, so be sure to update your submodules: git submodule update --init --recursive

Prerequisites

Visual Studio 2017

You will need the following optional components:

  • UWP
  • Windows 10 SDK
  • Android

You can add these to your Visual Studio installation via:

"C:\Program Files (x86)\Microsoft Visual Studio\Installer\vs_installer.exe" modify ^
--installPath "C:\Program Files (x86)\Microsoft Visual Studio\2017\Enterprise" ^
--add Microsoft.VisualStudio.Component.UWP.Support ^
--add Microsoft.VisualStudio.Component.Windows10SDK.17134 ^
--add Component.Android.NDK.R15C ^
--add Component.Android.NDK.R15C_3264 ^
--add Component.Android.SDK19.Private ^
--add Component.Android.SDK21.Private ^
--add Component.Android.SDK22.Private ^
--add Component.Android.SDK23 ^
--add Component.Android.SDK23.Private ^
--add Component.Android.SDK25.Private ^
--add Component.MDD.Android

Installing

Build the Code

The code can be built from Visual Studio via:

  1. Open Source\Arcana.cpp.sln.
  2. Select a target configuration (e.g. Debug) and platform (e.g. x86).
  3. Build the solution.

Alternatively, the code can be built from the command line via:

  1. Open the Developer Command Prompt for VS 2017
  2. Type msbuild Source\Arcana.cpp.sln /p:Configuration=Release /p:Platform=x86

Replace Release and x86 with whatever configuration and platform you would like to build locally.

Running the tests

The unit tests can be run within Visual Studio via Test Explorer, or from the Developer Command Prompt for VS 2017 via:

"C:\Program Files (x86)\Microsoft Visual Studio\2017\Enterprise\Common7\IDE\Extensions\TestPlatform\vstest.console.exe" .\BuildOutput\Debug\Win32\Arcana.UWP.Test\Bin\Arcana.UWP.Test.dll

Deployment

There is no official deployment mechanism available at this time.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

arcana.cpp does not use SemVer. Instead, it uses a version derived from the current date. Therefore, the version contains no semantic information.

Maintainers

With questions, please contact one of the maintainers:

Credits

Arcana owes especial thanks to:

Reporting Security Issues

Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) at [email protected]. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the MSRC PGP key, can be found in the Security TechCenter.