From 97ced8c6a36af9d2a6601489ab4ba0b6cef13df5 Mon Sep 17 00:00:00 2001
From: anton <haglundanton+github@gmail.com>
Date: Sun, 4 Mar 2018 14:03:29 +0100
Subject: [PATCH] Rename test.c to sample.c

Signed-off-by: anton <haglundanton+github@gmail.com>
---
 .gitignore         |  2 +-
 Makefile           | 12 ++++++------
 README.md          |  4 ++++
 test.c => sample.c |  0
 4 files changed, 11 insertions(+), 7 deletions(-)
 rename test.c => sample.c (100%)

diff --git a/.gitignore b/.gitignore
index e05534c..0151b9b 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,5 +2,5 @@ FairRank
 data/*
 .*.swp
 *.o
-test
+sample
 libfairrank.so
diff --git a/Makefile b/Makefile
index 68d70e4..16b5798 100644
--- a/Makefile
+++ b/Makefile
@@ -12,11 +12,11 @@ FairRank.o: FairRank.cpp
 libfairrank.so: FairRank.o fairrank.h
 	$(CXX) $(CXXFLAGS) -shared -lc -o $@ FairRank.o
 
-testrun: test
-	LD_LIBRARY_PATH=./ ./test
+samplerun: sample
+	LD_LIBRARY_PATH=./ ./sample
 
-test: test.c libfairrank.so
-	$(CC) $(CFLAGS) test.c -o $@ -L. -lfairrank
+sample: sample.c libfairrank.so
+	$(CC) $(CFLAGS) sample.c -o $@ -L. -lfairrank
 
 run: FairRank data/results
 	@./FairRank
@@ -30,6 +30,6 @@ data/results:
 	@echo Sample results generated to data/results
 
 clean:
-	@rm -f FairRank test *.o *.so
+	@rm -f FairRank sample *.o *.so
 
-.PHONY: clean run testrun
+.PHONY: clean run samplerun
diff --git a/README.md b/README.md
index cf18ddf..f428803 100644
--- a/README.md
+++ b/README.md
@@ -43,3 +43,7 @@ Statistics
 When running FairRank statistics will be presented on Standard Output, but also
 a file ``data/stats`` will be written that contains the current leaderboard.
 
+Dynamic library
+---------------
+
+See [sample.c](sample.c) for an example of how to use libfairrank.so.
diff --git a/test.c b/sample.c
similarity index 100%
rename from test.c
rename to sample.c