Skip to content

Commit 6cb8315

Browse files
Initial commit
0 parents  commit 6cb8315

2 files changed

Lines changed: 34 additions & 0 deletions

File tree

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# HDPS
2+
3+
## Introduction
4+
5+
The HDPS system is a modular plug-in system intended for visualization applications.
6+
7+
The system consists of a compact core which handles:
8+
9+
* Plug-in loading and dependency resolution
10+
* Data storage and data synchronization
11+
* Providing a base application window.
12+
13+
Additionally, a complementary public library is generated which provides:
14+
15+
* The base classes from which all plug-ins extend
16+
* Basic rendering and computation classes
17+
* Graphics utility classes
18+
* Common GUI base classes
19+
20+
## Requirements
21+
22+
* Qt 5.13 (https://www.qt.io/download)
23+
24+
## Documentation
25+
Documentation of the system is automatically generated by [Doxygen](http://www.doxygen.nl/) and available [here]().
26+
27+
## Usage
28+
29+
1. Make sure Qt 5.13 is installed on your system and is added to your Path environment variable.
30+
2. Retrieve the latest HDPS executable from [here](https://github.com/hdps/PublicWiki/releases/tag/v0.0.1)
31+
3. Download the .zip file and extract it on your computer
32+
4. Add a user environment variable called `HDPS_INSTALL_DIR` that points to the `HDPS` folder.
33+
5. Continue to write your first [plugin](https://github.com/hdps/PublicWiki/wiki/Writing-your-first-Plugin)

_config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
theme: jekyll-theme-cayman

0 commit comments

Comments
 (0)