Skip to content

Commit a27f531

Browse files
committed
updated readme
1 parent 88ea98f commit a27f531

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

README.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,22 @@ It can be used within code generators or libraries. For more information see
1111

1212
## Install
1313

14-
### Prerequisites
14+
### Prerequisites
15+
First following items should be installed:
1516
* CMake
1617
* C++ compiler (GCC, ICC, or CLang)
17-
* METIS and OpenMP (optional) dependency for running the demo efficiently
18-
and are handled by the cmake.
18+
* METIS (optional) dependency for running the demo efficiently
19+
and is handled by the cmake. If you have installed the package using
20+
a packet manager (e.g., apt of homebrew), CMake should be able to detect it.
21+
Otherwise, it installs METIS from source internally.
22+
* OpenMP (optional) for running some parts of the code in parallel. If you
23+
use GCC/ICC then OpenMP should be supported natively. If you use Apple CLang,
24+
you probably need to install OpenMP using `homebrew install libomp`. You can
25+
* also install LLVM usng `brew install llvm` which support OpenMP natively.
1926

20-
### Linux
21-
Then install LBC by following commands:
27+
28+
### Build
29+
Then build LBC, using the following:
2230

2331
```bash
2432
mkdir build
@@ -28,14 +36,11 @@ make
2836
```
2937

3038

31-
### Mac
32-
Setting the C and CXX compilers to GCC and then follow the Linux
33-
instructions. For example:
34-
`-DCMAKE_CXX_COMPILER=/usr/local/Cellar/gcc\@9/9.3.0_2/bin/g++-9 -DCMAKE_C_COMPILER=/usr/local/Cellar/gcc\@9/9.3.0_2/bin/gcc-9`
39+
You can always set `-DCMAKE_CXX_COMPILER=` and `-DCMAKE_C_COMPILER=` to use
40+
a different compiler. For example:
41+
`cmake -DCMAKE_CXX_COMPILER=/usr/local/Cellar/gcc\@9/9.3.0_2/bin/g++-9
42+
-DCMAKE_C_COMPILER=/usr/local/Cellar/gcc\@9/9.3.0_2/bin/gcc-9 ..`
3543

36-
Alternatively, you can use CLang using `brew install llvm`.
37-
The default clang on Mac might not work so make sure to set it llvm clang:
38-
`-DCMAKE_C_COMPILER=/usr/local/opt/llvm/bin/clang -DCMAKE_CXX_COMPILER=/usr/local/opt/llvm/bin/clang++`
3944

4045
## Example
4146
The example directory shows how to call LBC API and iterate over

0 commit comments

Comments
 (0)