Skip to content

Commit 38b5e4e

Browse files
committed
Updated documentation
1 parent c68fbb8 commit 38b5e4e

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

+14-2
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,18 @@ Usage
1010

1111
1. Ensure that the `+Cliquer` directory is a subdirectory of a directory in your MATLAB path. Do *not* add the `+Cliquer` directory to your MATLAB path.
1212

13-
2. Execute the MATLAB command `Cliquer.Compile()` to compile both the C program Cliquer and the MEX interface. This compile function is provided for convenience but basically just compiles Cliquer, compiles the MEX function, and then moves the MEX function into the package directory.
13+
2. Execute make.m from within this repository to compile the mex files
14+
```MATLAB
15+
% Running make.m
16+
make
17+
```
1418

15-
3. Cliquer's functionality can now be accessed with the command `Cliquer.FindAll`, and documentation can be accessed with `help Cliquer.FindAll`.
19+
3. Cliquer's functionality can now be accessed with the command `Cliquer.FindAll`, and documentation can be accessed with `help Cliquer.FindAll`.
20+
21+
4. Check installation using the following example
22+
```MATLAB
23+
A = eye(10);
24+
[ncliques mtxcliques] = Cliquer.FindAll(A,2,2,false,1000);
25+
```
26+
27+
5. Be sure to make check that your input is a symmetric matrix using `issymmetric(A)`. Otherwise running this program results in a segmentation fault.

0 commit comments

Comments
 (0)