Skip to content

Commit d99cb94

Browse files
authored
Make the required dependencies clearer
The README did not specify the requirements for building from source good enough, namely the C++ compiler was not mentioned, which misled several people. This should be clearer now. Closes gatagat#24
1 parent c2b6309 commit d99cb94

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

+9-5
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,16 @@ Approach", Computer Ops Res. 23, 917-932 (1996)<br>
2828
Installation
2929
------------
3030

31-
#### Dependencies
31+
#### Runtime dependencies
3232

33-
lap requires:
33+
Running lap requires:
3434

3535
* Python (2.7, 3.6, 3.7)
3636
* NumPy (>=1.10.1)
37-
* Cython (>=0.21) - to compile the wrapper
38-
* SciPy, pytest, pytest-timeout - only for testing
37+
38+
In addition to above, running the tests requires:
39+
40+
* SciPy, pytest, pytest-timeout
3941

4042
#### Install using pip
4143

@@ -49,7 +51,9 @@ Alternatively, you can install lap directly from the repository:
4951

5052
#### Install from source
5153

52-
1. Clone
54+
1. Install a C++ compiler (e.g., g++)
55+
2. Install Cython (>=0.21)
56+
3. Clone
5357

5458
git clone https://github.com/gatagat/lap.git
5559

0 commit comments

Comments
 (0)