From c7e4640e1018354daa3a1affed93b395803fdebc Mon Sep 17 00:00:00 2001 From: Luigi Capogrosso Date: Fri, 29 Nov 2024 10:20:51 +0100 Subject: [PATCH] Update BibTeX and minor changes --- README.md | 41 +++++++++++++++-------------------------- 1 file changed, 15 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 1f24a90..ee59bf9 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,12 @@ [![Unix Status](https://github.com/luigicapogrosso/HermesBDD/actions/workflows/unix.yml/badge.svg)](https://github.com/luigicapogrosso/HermesBDD/actions/workflows/unix.yml) [![Windows Status](https://github.com/luigicapogrosso/HermesBDD/actions/workflows/windows.yml/badge.svg)](https://github.com/luigicapogrosso/HermesBDD/actions/workflows/windows.yml) -HermesBDD is a novel multi-core and multi-platform [binary decision diagrams](https://en.wikipedia.org/wiki/Binary_decision_diagram) package focused on high performance and usability. HermesBDD supports a static and dynamic memory management mechanism, the possibility to exploit lock-free hash tables, and a simple parallel implementation of the ITE procedure based on a higher-level wrapper for threads and futures. +HermesBDD is a novel multi-core and multi-platform [binary decision diagrams](https://en.wikipedia.org/wiki/Binary_decision_diagram) package focused on high performance and usability. +HermesBDD supports a static and dynamic memory management mechanism, the possibility of exploiting lock-free hash tables, and a simple parallel implementation of the ITE procedure based on a higher-level wrapper for threads and futures. For more information on progress reports, please visit the HermesBDD [home page](https://luigicapogrosso.github.io/HermesBDD/). ## Dependencies ## - HermesBDD has the following dependencies: - **CMake** (mandatory), for compiling; @@ -19,41 +19,35 @@ HermesBDD has the following dependencies: For further information about CMake and Sphinx, check the following [1](https://cmake.org/) and [2](https://www.sphinx-doc.org/en/master/) documentation pages, respectively. ## Building ## - -The library is tested for compilation using GCC (minimum required: 10.2), Clang (minimum required: 11.0), and MSVC (minimum required: 19.20). To build the library from sources in a clean way, it is preferable that you set up a build subdirectory, say: - +The library is tested for compilation using GCC (minimum required: 10.2), Clang (minimum required: 11.0), and MSVC (minimum required: 19.20). +To build the library from sources in a clean way, it is preferable that you set up a build subdirectory, say: ``` $ mkdir build && cd build ``` Then, you can prepare the build environment, choosing a `Release` build for maximum performance: - ``` $ cmake .. -DCMAKE_BUILD_TYPE=Release ``` At this point, if no error arises, you can build with: - ``` $ cmake --build . ``` To install the library globally from built sources, you must do the following: - ``` $ cmake --build . --target install ``` - -using `sudo` if you require administrator privileges for a Linux installation. Just so you know, the installation will build the whole distribution beforehand, so it is better that you first build the other targets without administrator privileges to build the install target. +using `sudo` if you require administrator privileges for a Linux installation. +The installation will build the whole distribution beforehand, so it is better that you first build the other targets without administrator privileges to build the install target. To find the installed library under Ubuntu, you may need to set the `LD_LIBRARY_PATH` in the `.bashrc` file of your home directory: - ``` export LD_LIBRARY_PATH=/usr/local/lib ``` ### CMake options ### - Available options are: | CMake Option | Description | Default Value | @@ -64,18 +58,15 @@ Available options are: | COVERAGE | Enable coverage reporting | OFF | ## Contribution guidelines ## - HermesBDD is not yet feature-complete, and many interesting things remain left -for _you_ to do. So, this project welcomes contributions and suggestions. If you would -like to contribute to HermesBDD or do an internship or thesis, please don't hesitate to contact the authors. +for _you_ to do. +So, this project welcomes contributions and suggestions. +If you would like to contribute to HermesBDD or do an internship or thesis, please don't hesitate to contact the authors. ## License ## - The software files in this repository are provided under the [MIT License](./LICENSE). - ## Authors ## - [Luigi Capogrosso](https://www.capogrosso.eu/), Luca Geretti, Marco Cristani, Franco Fummi, Tiziano Villa *Department of Computer Science, University of Verona, Italy* @@ -83,15 +74,13 @@ The software files in this repository are provided under the [MIT License](./LIC `name.surname@univr.it` ## Citation ## - If you use [**HermesBDD**](https://ieeexplore.ieee.org/abstract/document/10139480), please, cite the following paper: ``` -@inproceedings{capogrosso2023hermesbdd, - title={HermesBDD: A Multi-Core and Multi-Platform Binary Decision Diagram Package}, - author={Capogrosso, Luigi and Geretti, Luca and Cristani, Marco and Fummi, Franco and Villa, Tiziano}, - booktitle={2023 26th International Symposium on Design and Diagnostics of Electronic Circuits and Systems (DDECS)}, - pages={87--90}, - year={2023}, - organization={IEEE} +@InProceedings{capogrosso2023hermesbdd, + author = {Capogrosso, Luigi and Geretti, Luca and Cristani, Marco and Fummi, Franco and Villa, Tiziano}, + booktitle = {26th International Symposium on Design and Diagnostics of Electronic Circuits and Systems (DDECS)}, + title = {{HermesBDD: A Multi-Core and Multi-Platform Binary Decision Diagram Package}}, + year = {2023}, + doi = {10.1109/ddecs57882.2023.10139480}, } ```