added TODO & README

[physik/nlsop.git] / README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..024970c
--- /dev/null
+++ b/README
@@ -0,0 +1,18 @@
+nlsop
+-----
+
+requirements:
+
+- directfb api (www.directfb.org) for visualization only
+- /dev/urandom
+
+install:
+
+./configure && make && make install
+
+run:
+
+./nlsop -h
+
+-
+have fun, frank