From 2841e948858544775e2b4bd9a693ce6ce42438ff Mon Sep 17 00:00:00 2001
From: Luc Giffon <luc.giffon@lis-lab.fr>
Date: Fri, 12 Jul 2019 15:33:29 +0200
Subject: [PATCH] update readme with requirements

---
 README.md | 20 ++++++++++++++++++--
 1 file changed, 18 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 5aebf00..d5b0c46 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,19 @@
-# nystrom-layer
+# Minimal working example of Nyström layer
 
-Minimum working example of Nystrom Layer implementation
\ No newline at end of file
+Minimum working example of the Nystrom Layer implementation.
+
+## Requirements
+
+Those requirements versions may not be absolutely necessary but they are the versions
+used while writing this simple example
+
+- `python=3.6` 
+- `keras=2.2.4`
+- `tensorflow=1.13.1`
+- `numpy=1.16.4`
+
+## Files
+
+- `nystrom_layer.py`: the minimal working example that you can just execute as it is.
+
+- `keras_kernel_functions.py`: some common kernel functions implemented in keras.
\ No newline at end of file
-- 
GitLab