From 03a7bc68cc6a83dcd670673b9349acbb9cad9e1f Mon Sep 17 00:00:00 2001 From: Holger Peters Date: Wed, 30 Nov 2016 16:36:51 +0100 Subject: [PATCH 1/2] Use more markup in the readme. --- README.md | 70 +++++++++++++++++++++++++++++++++---------------------- 1 file changed, 42 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 591f404..0f05823 100644 --- a/README.md +++ b/README.md @@ -2,46 +2,60 @@ Interface to NeuroBayes(R) for academic purpose -The NeuroBayes package is available under the NeuroBayes license from Blue Yonder GmbH. -Please contact neurobayes@blue-yonder.com for general information and for information about the license. +The NeuroBayes package is available under the NeuroBayes license from Blue +Yonder GmbH. Please contact neurobayes@blue-yonder.com for general information +and for information about the license. + +This repository provides the C++ Interface of the NeuroBayes package. You can +only build this project if you obtained the NeuroBayes licence and NeuroBayes +Core library from Blue Yonder GmbH. + +The NeuroBayes C++ Interface is usually already shipped with the NeuroBayes +package. The NeuroBayes Core library does only depenend on a very small set of +system libraries like `libc` and `libgfortran`. The NeuroBayes C++ Interface +depends on `libstdc++`. It may be necessary to recompile the C++ Interface in +the future to support new platforms, hence Blue Yonder GmbH decided to release +the source code of the C++ Interface under the MIT licence for the convenience +of the NeuroBayes user community (in particular for high energy physics +experiments). -This repository provides the C++ Interface of the NeuroBayes package. You can only build this project if you -obtained the NeuroBayes licence and NeuroBayes Core library from Blue Yonder GmbH. +# Build process and installation -The NeuroBayes C++ Interface is usually already shipped with the NeuroBayes package. -The NeuroBayes Core library does only depenend on a very small set of system libraries like libc and libgfortran, -on the other hand the NeuroBayes C++ Interface depends on libstdc++. -It may be necessary to recompile the C++ Interface in the future to support new platforms, -hence Blue Yonder GmbH decided to release the source code of the C++ Interface under the MIT licence for the convinience -of the NeuroBayes user community (in particular for high energy physics experiments). +Extract the NeuroBayes Core shared library named `libNeuroBayesCore_shared.so` +from the package you obtained from Blue Yonder GmbH and copy it into the +previously empty directory `./core`. +To build the NeuroBayes C++ Interface, run: -# Build process and installation - * Extract the NeuroBayes Core shared library named libNeuroBayesCore\_shared.so from the package you obtained from Blue Yonder GmbH and copy it into the previously empty directory core. - * cd build/ - * cmake ../ - * make + cd build/ + cmake ../ + make ## Building rpm, deb or tgz packages -Optionally you can build rpm, deb and tgz packages using - * make package -Additional third-party libraries are required to do so. +Optionally you can build rpm, deb and tgz packages using `make package`. +Additional third-party libraries are required to do so. ## Maxnode -The NeuroBayes Core library is optimized for a maximum number of nodes. -The maximum number of nodes is printed by the NeuroBayes Teacher -at the start of the program e.g. execute the minimaltest executable and search for NB\_MAXNODE. -The default number is 100. If your library is optimized for a different number of nodes, -you have to provide the correct number using an environment variable named MAXNODE\_PREPRO. -during the build process e.g. MAXNODE\_PREPRO=200 cmake ../ + +The NeuroBayes Core library is optimized for a maximum number of nodes. The +maximum number of nodes is printed by the NeuroBayes Teacher at the start of +the program e.g. execute the minimaltest executable and search for NB_MAXNODE. +The default number is 100. If your library is optimized for a different number +of nodes, you have to provide the correct number using an environment variable +named `MAXNODE_PREPRO`. during the build process e.g. + + MAXNODE_PREPRO=200 cmake ../ ## Tests -To verify the correctness of your executable, you can execute the following test suits: - * cd build - * ./minimaltest - * ./interfacetest + +To verify the correctness of your executable, you can execute the following +test suits: + + cd build + ./minimaltest + ./interfacetest The minimaltest provides also a minimal example to get you started. From 233c4cf002c4385e87b27267f9096d12618c39b1 Mon Sep 17 00:00:00 2001 From: Holger Peters Date: Wed, 30 Nov 2016 16:42:40 +0100 Subject: [PATCH 2/2] markup `NB_MAXNODE` as preformatted text --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0f05823..dec2c7c 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,9 @@ Additional third-party libraries are required to do so. The NeuroBayes Core library is optimized for a maximum number of nodes. The maximum number of nodes is printed by the NeuroBayes Teacher at the start of -the program e.g. execute the minimaltest executable and search for NB_MAXNODE. +the program e.g. execute the minimaltest executable and search for `NB_MAXNODE` +in its output. + The default number is 100. If your library is optimized for a different number of nodes, you have to provide the correct number using an environment variable named `MAXNODE_PREPRO`. during the build process e.g.