From ff4c21dbd9529ff2c5e112f40c3b455b508438b5 Mon Sep 17 00:00:00 2001
From: Sam Hadow <sam.hadow@inbox.lv>
Date: Thu, 15 May 2025 20:58:08 +0200
Subject: [PATCH] readme

---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/README.md b/README.md
index e69de29..a786d2c 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,30 @@
+Pagerank algorithm in C.
+
+## build
+```
+make
+```
+
+## usage
+Matrix market format can be used with ".mtx" at the end of the input file. Rutherford Boeing format can only be used if the arcs have an explicit value (not an implicit 0 or 1), input file then needs to end in ".rb".  
+
+Run binary for a single comparison:
+```
+./out/pagerank --matrix <path> --epsilon <value> --alpha <value>
+```
+
+
+Python script to generate graphs with matplotlib to compare the Gauß Seidel and power method for pagerank
+```
+usage: main.py [-h] [--alpha ALPHA] [--max_alpha MAX_ALPHA] [--epsilon EPSILON] [--matrix MATRIX]
+
+Pagerank vs Gauß Seidel execution time depending on α
+
+options:
+  -h, --help            show this help message and exit
+  --alpha ALPHA         number of alpha to test in the range (0,1)
+  --max_alpha MAX_ALPHA
+                        stay strictly below this alpha
+  --epsilon EPSILON     epsilon value for the convergence
+  --matrix MATRIX       path to the matrix file
+```