fixed nlsop for packaging ..

[physik/nlsop.git] / README

diff --git a/README b/README
index 3faa790..dc460c4 100644 (file)
--- a/README
+++ b/README
@@ -1,33 +1,46 @@
 nlsop
 #####
 
-requirements:
--------------
+requirements (including headers):
+---------------------------------
 
-- directfb api (www.directfb.org) for visualization only
+- directfb api (http://www.directfb.org) for visualization only
 
 - /dev/urandom
 
+- 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.dyndns.org:/my-code co api
+  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:
---------
+install (nlsop):
+----------------
+
+./configure &&
+make -f Makefile links &&
+make -f Makefile nlsop
+
+install other tools:
+--------------------
 
-./configure && make -f Makefile nlsop && make -f Makefile install
+make links
+make dft linescan nlsop_make_cryst nlsop_create_cbox
+(no install target)
 
-run:
-----
+run (nlsop):
+------------
 
 (use '-h' to see the individual options of every binary)
 
 nlsop_server:
 
-  install and run the binary on a stable, well connected host and enough
+  install and run the binary on a stable, well connected host with enough
   disk space for the nlsop save files.
 
 nlsop_client: