Windows Setup

Shiro has had historically problems building on Windows. Thanks to the work of Emily this has greatly improved. For convenience, a build script is directly included in the repository. The PS> directive at the start shows that a command should be executed in PowerShell. This is not part of the command and should not be copied.

Requirements

• Visual Studio 2017 or higher
• vcpkg

Compiling

In order to compile Shiro, we need to first clone the source code from this GitHub repository:

PS> git clone https://github.com/Marc3842h/shiro.git
PS> cd shiro

Next run the build script. This will install required dependencies using vcpkg, generate Visual Studio files and instruct Visual Studio to build those:

PS> .\windows_setup_build.bat

After this has ended, the final Shiro binary as well as all required configuration files can be found in the Release directory.

Starting Shiro

Before starting Shiro, please have a look at configuring Shiro. Without the proper configuration, Shiro will fail to start. After you've successfully configured Shiro, it can be launched easily using the following command:

PS> .\shiro.exe 

If Shiro has successfully started, you should see something similar the following output:

2019-06-03 12:11:03.299 (   2.034s) [main thread     ]               shiro.cc:117   INFO| Welcome to Shiro. Listening on http://127.0.0.1:8080/.
2019-06-03 12:11:03.300 (   2.036s) [main thread     ]               shiro.cc:118   INFO| Press CTRL + C to quit.