aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichał Łyszczek <michal.lyszczek@gmail.com>2017-05-23 01:57:10 +0200
committerMichał Łyszczek <michal.lyszczek@gmail.com>2017-05-23 01:57:10 +0200
commit45b6bedef0e7a5f453ae303ac5ada0c5ca946e1d (patch)
treeac2bb14f2fb6266f17bb4591720cd7aa7061211e
parentea57d6255e056df9441302c5e23acd7684e95d84 (diff)
downloadmemperf-45b6bedef0e7a5f453ae303ac5ada0c5ca946e1d.tar.gz
memperf-45b6bedef0e7a5f453ae303ac5ada0c5ca946e1d.tar.bz2
memperf-45b6bedef0e7a5f453ae303ac5ada0c5ca946e1d.zip
Added proper readme file
l---------readme1
-rw-r--r--readme.md43
2 files changed, 43 insertions, 1 deletions
diff --git a/readme b/readme
deleted file mode 120000
index 791b25b..0000000
--- a/readme
+++ /dev/null
@@ -1 +0,0 @@
-memperf.1 \ No newline at end of file
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..4bf05d5
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,43 @@
+About
+=====
+
+Application to perform memory benchmark.
+
+Dependencies
+============
+
+Application is written in ANSI C and that is all you need to compile and run
+this application. Just note, that you will be stuck only with *clock\_t* timer,
+which may have reduced resolution. If automake detects *clock\_gettime*
+function, additional clock *CLOCK\_REALTIME* will be available which has at
+last as good resolution as *clock\_t*
+
+Compiling and Installing
+========================
+
+memperf uses automake, so compilation is pretty standard
+
+autoreconf -i
+./configure
+make
+make install
+
+tests can be run with
+
+make check
+
+License
+=======
+
+Library is licensed under BSD 2-clause license. See LICENSE file for details.
+
+Contact
+=======
+
+Michał Łyszczek <michal.lyszczek@bofc.pl>
+
+Thanks to
+=========
+
+Myself, for creating mtest (https://github.com/mlyszczek/mtest) - a small and
+nice framework for unit testing in C.