|
1 | 1 | # PlusLib
|
2 |
| -Software library for data acquisition, pre-processing, and calibration for navigated image-guided interventions. See more information at www.plustoolkit.org. |
| 2 | +Software library for data acquisition, pre-processing, and calibration for navigated image-guided interventions. See more information at [PlusToolkit.org](http://www.plustoolkit.org). |
3 | 3 |
|
4 |
| -# Bugs? |
5 |
| -Please file an issue report over at https://github.com/PlusToolkit/PlusLib/issues |
| 4 | +## Bugs |
| 5 | +Please file an issue report over at https://github.com/PlusToolkit/PlusLib/issues. |
6 | 6 |
|
7 |
| -# Questions? |
8 |
| -Please start a discussion at https://github.com/PlusToolkit/PlusLib/discussions |
| 7 | +## Questions |
| 8 | +Please start a discussion at https://github.com/PlusToolkit/PlusLib/discussions. |
| 9 | + |
| 10 | +## Documentation |
| 11 | +- [PlusLib API documentation](http://perk-software.cs.queensu.ca/plus/doc/nightly/dev/): generated nightly from the latest code version. |
| 12 | +- [Plus devices](https://plustoolkit.github.io/devicecode): description of the steps requires to implement a new device interface. |
| 13 | +- Notepad++ log file syntax highlighting is available via [this user-defined language](https://plustoolkit.github.io/files/PlusLog_NotepadPP_Language.xml). |
| 14 | + |
| 15 | +## Testing dashboards |
| 16 | + |
| 17 | +- [PlusLib dashboard](http://perkdata.cs.queensu.ca/CDash/index.php?project=PlusLib): results of automatic tests of the Plus library |
| 18 | +- [PlusApp dashboard](http://perkdata.cs.queensu.ca/CDash/index.php?project=PlusApp): results of automatic tests of the Plus applications |
| 19 | + |
| 20 | + |
| 21 | +## Build instructions |
| 22 | + |
| 23 | +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). |
| 24 | + |
| 25 | +Supported platforms: |
| 26 | +- 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 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. |
| 27 | +- 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. |
| 28 | +- 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. |
| 29 | + |
| 30 | +## Contributing |
| 31 | + |
| 32 | +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/PlusLib/blob/master/CONTRIBUTING.md). |
| 33 | + |
| 34 | +When making code changes, please follow Plus coding conventions. The Astyle formatter can be used to quickly format a file to Plus standards. |
| 35 | +* [PLUS format](https://github.com/PlusToolkit/PlusLib/blob/master/.astylerc) |
| 36 | + |
| 37 | +## License |
| 38 | + |
| 39 | +Plus has a BSD-style license, which allows any kind of use for free. See more details [here](https://github.com/PlusToolkit/PlusLib/blob/master/License.txt). |
0 commit comments