Skip to content

Commit d7b2546

Browse files
committed
Change developers guide to a link to PlusLib/README.md
1 parent dbb0247 commit d7b2546

File tree

2 files changed

+4
-41
lines changed

2 files changed

+4
-41
lines changed

_includes/themes/twitter/top.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ <h2>User's guide</h2>
3535
<div class="span4">
3636
<h2>Developer's guide</h2>
3737
<p>How to build the toolkit on various operating systems to customize or extend it.</p>
38-
<p><a class="btn" href="developersguide.html">View developer's guide &raquo;</a></p>
38+
<p><a class="btn" href="https://github.com/PlusToolkit/PlusLib/blob/master/README.md">View developer's guide &raquo;</a></p>
3939
</div>
4040
<div class="span4">
4141
<h2>Contact</h2>

developersguide.md

Lines changed: 3 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,10 @@
11
---
2-
layout: page
2+
layout: link
33
title: Developer's guide
44
group: navigation
55
order: 5
66
description: ""
7+
linkurl: "https://github.com/PlusToolkit/PlusLib/blob/master/README.md"
8+
linkname: "Plus developer's guide"
79
---
810
{% include JB/setup %}
9-
10-
Source code
11-
-----------
12-
13-
Plus toolkit contains three main repositories:
14-
- [PlusLib](https://github.com/PlusToolkit/PlusLib/): Library that contains all data acquisition and processing implementation. It contains a few sipmle tools and test applications but primarily intended to be linked into software applications.
15-
- [PlusApp](https://github.com/PlusToolkit/PlusApp/): Software applications with graphical user interface that use PlusLib to make features available to end users.
16-
- [PlusBuild](https://github.com/PlusToolkit/PlusBuild/): Small project that downloads and builds PlusLib, PlusApp and all their dependencies (VTK, ITK, etc.).
17-
18-
Documentation
19-
-----------------
20-
21-
- <a href="http://perk-software.cs.queensu.ca/plus/doc/nightly/dev/">PlusLib API documentation</a>: generated nightly from the latest code version.
22-
- [Plus devices](devicecode.md): description of the steps requires to implement a new device interface.
23-
- Notepad++ log file syntax highlighting is available via [this user-defined language](files/PlusLog_NotepadPP_Language.xml).
24-
25-
Testing dashboards
26-
------------------
27-
28-
- [PlusLib dashboard](http://perkdata.cs.queensu.ca/CDash/index.php?project=PlusLib): results of automatic tests of the Plus library
29-
- [PlusApp dashboard](http://perkdata.cs.queensu.ca/CDash/index.php?project=PlusApp): results of automatic tests of the Plus applications
30-
31-
Build instructions
32-
------------------
33-
34-
Plus library files and all required libraries and toolkits are automatically downloaded, configured, and built using CMake "superbuild" method (using CMake external project infrastructure). Build instructions are available in [PlusBuild repository](https://github.com/PlusToolkit/PlusBuild/blob/master/README.md).
35-
36-
Supported platforms:
37-
- 32/64-bit builds: Plus can be built in either 32-bit or 64-bit mode. 64-bit applications have the advantage of larger available memory space (which is useful for certain applications, such as recording a large number of frames in memory, or reconstructing high-resolution volumes), but only a few hardware devices have 64-bit compatible drivers. If available memory is not a concern &nbsp;then use only 32-bit builds. If lots of memory is needed, and the application does not have to use tracking or imaging hardware devices directly then 64-bit build of Plus can be used. If both hardware support and lots of memory is needed then a 32-bit build of Plus can be used for data acquisition and the acquired data can be passed on to a 64-bit Plus or other application for further processing.
38-
- Windows 7 32-bit/64-bit, Windows 10 32-bit/64-bit, Windows XP 32-bit embedded, Ubuntu 16.04, and MacOSX operating systems are fully supported and regularly tested.
39-
- Running on Linux and MacOS: Unfortunately, many of the drivers written for devices are Windows specific, and thus capture cannot be done on a Linux or MacOSX machine. It is recommended to do the data acquisition on Windows and stream the acquired data to the Linux or MacOS computer for further processing.
40-
41-
Contributing
42-
----------
43-
44-
We follow the standard [GitHub Flow](https://guides.github.com/introduction/flow/) process. In short: send a pull request with proposed changes. See more information [here](https://github.com/PlusToolkit/PlusBuild/blob/master/CONTRIBUTING.md).
45-
46-
When making code changes, please follow Plus coding conventions. The Astyle formatter can be used to quickly format a file to Plus standards.
47-
* [PLUS format](https://github.com/PlusToolkit/PlusLib/blob/master/.astylerc)

0 commit comments

Comments
 (0)