Skip to content

Commit

Permalink
Update index.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pevisscher committed Feb 20, 2016
1 parent 28617af commit ea8a97b
Showing 1 changed file with 16 additions and 4 deletions.
20 changes: 16 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# BSPLib
[BSPLib](https://wwww.bsplib.eu) is a fast, and easy to use C++ implementation of the Bulk Synchronous Parallel (BSP) threading model.
[BSPLib](https://wwww.bsplib.eu) is a fast, and easy to use C++ implementation of the Bulk Synchronous Parallel (BSP) threading model. This model is mainly used in the scientific computing field, but can also be applied more general in computer science. This library includes an extended version the standard BSP interface to perform better, and made it more easy to use.

#BSP
The BSP specification can be found [here](bsp.pdf) and is maintained by [bsp-worldwide.org](http://www.bsp-worldwide.org). Parts of the
Expand All @@ -13,7 +13,7 @@ The code can be found [here](https://github.com/Zefiros-Software/BSPLib). See [t
* Reliable: We have an extensive testing suite, making sure we do not break forward and backward compatiblity.
* Easy to use: The library is completely header only. Also next to our improved c++ interface, we shipped the
classic BSP C interface.
* Cross platform: Designed to only use C++11, with no external dependecies.
* Cross platform: Designed to only use C++11, with no external dependencies.
* Warning free, compiled on the highest warning level.

## Installation
Expand All @@ -30,7 +30,7 @@ void main( int32_t, const char ** )
{
BSPLib::Execute( []
{
std::cout << "Hello BSP Worldwide from process " << BSPLib::Classic::ProcId()
std::cout << "Hello BSP Worldwide from process " << BSPLib::ProcId()
<< " of " << BSPLib::NProcs() << std::endl;
}, BSPLib::NProcs() );
}
Expand Down Expand Up @@ -126,6 +126,18 @@ When a bug is found, please insert it in the issue tracker, so we can resolve it
We are interested to find out what projects use BSPLib. We would love to include your projects here,
just shoot us a mail. :)

## Citing BSPLib
When you use BSPLib as part of a scientific publication, we would love you to cite this project. This BibTex snippet can be used:

```
@misc{bsplib2016,
author = {Mick van Duijn and Koen Visscher and Paul Visscher},
title = {{BSPLib}: a fast, and easy to use {C++} implementation of the {Bulk} {Synchronous} {Parallel} ({BSP}) threading model.},
abstract = {{BSPLib} is a fast, and easy to use {C++} implementation of the {Bulk} {Synchronous} {Parallel} ({BSP}) threading model. This model is mainly used in the scientific computing field, but can also be applied more general in computer science. This library includes an extended version the standard BSP interface to perform better, and made it more easy to use.},
howpublished = {\url{http://bsplib.eu/}}
}
```

## License
This project is licensed under the MIT license.

Expand All @@ -149,4 +161,4 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
```
```

0 comments on commit ea8a97b

Please sign in to comment.