From 60abc22a79cad7240724c030f2855ff4519a1dcd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Felipe=20Gon=C3=A7alves?= Date: Fri, 4 Aug 2017 18:30:14 -0300 Subject: [PATCH] Update and rename README to README.md Readme changed to .md file, and organized font styles. --- README => README.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) rename README => README.md (77%) diff --git a/README b/README.md similarity index 77% rename from README rename to README.md index 026121b..0b00ba8 100644 --- a/README +++ b/README.md @@ -1,12 +1,15 @@ -justTheCliques: Find maximal cliques, via the Bron Kerbosch algorithm, http://en.wikipedia.org/wiki/Bron%E2%80%93Kerbosch_algorithm -cp5: Fast clique percolation algorithm, described in http://arxiv.org/abs/1205.0038 +# MaximalCliques -== Copyright == +**justTheCliques:** Find maximal cliques, via the Bron Kerbosch algorithm, [Bron Kerbosch in Wikipedia](http://en.wikipedia.org/wiki/Bron%E2%80%93Kerbosch_algorithm) + +**cp5:** Fast clique percolation algorithm, described in [Cornell University Library](http://arxiv.org/abs/1205.0038) + +## Copyright Copyright 2009-2011 - Aaron McDaid aaronmcdaid@gmail.com. Licensed under GPL v3. See gpl.txt included with this package. -== Compiling == +## Compiling First, to get your hands on the latest code from GitHub. In a directory of your choice: @@ -14,7 +17,7 @@ In a directory of your choice: git clone --recursive https://github.com/aaronmcdaid/MaximalCliques.git make clean justTheCliques cp5 -== Usage == +## Usage ./justTheCliques your_edge_list.txt [--stringIDs] > cliques.txt @@ -37,9 +40,9 @@ did want to see the sizes of the cliques found, to ./justTheCliques edge_list.txt > /dev/null -== Input file == +## Input file -Each line of the your_edge_list.txt represents an edge. The first two fields +Each line of the **your_edge_list.txt** represents an edge. The first two fields (delimited by commas, pipes(|), spaces or tabs) are the names of the two nodes that are connected. Directionality is ignored, and self-loops will be rejected. Any other fields on the line are also ignored.