README

DynamO:- A general event-driven particle simulator.
http://www.dynamomd.org

*** INSTALLATION

 Please see a full tutorial on the DynamO website. A quick summary is
 # make
 And the executables will be installed into the bin directory. If you
 want to install the executables to /usr/bin, run
 # make install

 Please pay attention to the output of the make command, as this scans
 for required dependencies and will warn you if it is unable to build
 DynamO!

*** SOURCE CODE

 All of the source code is in the src/ directory. For more information
 on the source code please see the src/README file. Also take a look
 at the doxygen documentation (next section of this README).

*** DOCUMENTATION
 
 Some resources are in the docs/ directory; however, the bulk of the
 documentation will be available on the website.

 If you want the latest, up to date doxygen documentation, just run
 # doxygen
 in the same directory as this README. This will generate HTML
 docmentation in the docs/html directory.

*** TESTING

 There is a test script in scripts/test_dynarun.sh.
 
 You can run some OpenCL and other tests by running
 # make test

*** TROUBLESHOOTING/CONTRIBUTING 

 Please check the website and documentation if you're having any
 trouble. If these don't answer your questions, just email
 support@dynamomd.org. If you want to get involved, email support to
 let us know about it and submit patches using github.

*** LICENSE
 
 Everything in DynamO is licensed GPL3 unless otherwise marked. Please
 see COPYING for details of this license.