DHART
Loading...
Searching...
No Matches
DHART

Table of contents

  • Pre-requisites
  • Building with Microsoft Visual Studio 2019
  • Building with CMake's standalone client (cmake-gui)
  • Documentation
  • See the Contributing Guide for information on style guides.
  • See the Documentation Guide for information on documenting and building documentation.

This guide will describe how to retrieve the contents of this repository, and build from source.

Please note: Dhart is currently designed to run on a PC
running the Windows 10 operating system.

Also note: This guide is a 'work-in-progress' and subject to change.

Pre-requisites

Git for Windows:
If you do not already have Git for Windows on your machine,
please download and install Git for Windows at https://gitforwindows.org/

Microsoft Visual Studio 2019:
https://visualstudio.microsoft.com/downloads/
You may use the Community edition.

CMake (Windows win64-x64) Version 3.8 or higher
https://cmake.org/download/

Once the software above is installed on your machine, you may continue with the following:

0. Using Git Bash

Open Git Bash. Git Bash (MINGW64) begins at ~, your home directory.
You may remain here, or navigate to a directory of your choice.
In the next step, you will clone the dhart repository.

1. Cloning the repository

Type git clone git@g.nosp@m.ithu.nosp@m.b.com/cadop/dhart.git at the prompt
and hit ENTER. The repository will then be cloned to your local machine.

Now that a local copy of the dhart repository is on your machine,
you may build the project with either:

For a guide on how to obtain the output DLLS from this project after it has been generated and built, look at the guide on the Cmake Installation Step

Documentation

Documentation for dhart can be found in ./dhart/docs/

The codebase is comprised of sources from:

  • C++ (see ./dhart/docs/C++)
  • C# (see ./dhart/docs/C#)
  • Python (see ./dhart/docs/Python Docs)

C++

The C++ portion of the codebase uses a subset of the Boost libraries,
and the sources are included with this repository.

Because the Boost sources are included with dhart,
(in dhart/src/external/boost),
you do not need to download or install Boost to build the repository.

You may read more about Boost at their website: https://www.boost.org/

TBA: C# details
TBA: Python details