fixed nlsop for packaging ..

[physik/nlsop.git] / README

diff --git a/README b/README
index 024970c..dc460c4 100644 (file)
--- a/README
+++ b/README
@@ -1,18 +1,65 @@
 nlsop
------
+#####
 
-requirements:
+requirements (including headers):
+---------------------------------
+
+- directfb api (http://www.directfb.org) for visualization only
 
-- directfb api (www.directfb.org) for visualization only
 - /dev/urandom
 
-install:
+- ncurses
+
+- fftw3 (http://fftw.org), my own discrete fourier transform api is buggy.
+
+- my own minimal api. you can get it via cvs:
+
+  cvs -d:pserver:anonymous@hackdaworld.org:/my-code co api
+
+  you should downlaod it parllel to your nlsop dir, or use configure
+  option to specify the location instead.
+
+install (nlsop):
+----------------
+
+./configure &&
+make -f Makefile links &&
+make -f Makefile nlsop
+
+install other tools:
+--------------------
+
+make links
+make dft linescan nlsop_make_cryst nlsop_create_cbox
+(no install target)
+
+run (nlsop):
+------------
 
-./configure && make && make install
+(use '-h' to see the individual options of every binary)
 
-run:
+nlsop_server:
 
-./nlsop -h
+  install and run the binary on a stable, well connected host with enough
+  disk space for the nlsop save files.
+
+nlsop_client:
+
+  install and run it on a number of nodes you want to do the actual
+  calculation on.
+
+nlsop_gui:
+
+  run it to connect to the server to add jobs or get a status information
+  of the current jobs and clients.
+
+nlsop:
+
+  use this for visualizing/converting/researching the save files.
+  you may also use it for a non distributed calculation.
+
+
+--
 
--
 have fun, frank
+