Commit 4592c7a8 authored by Alexander Wiebel's avatar Alexander Wiebel

[DOC] updated and improved README and the like

parent 9c2cf6f8
......@@ -3,13 +3,13 @@
OpenWalnut is an open source tool for multi-modal medical and brain data
visualization. Its universality allows it to be easily extended and used in a
large variety of application cases. It is both, a tool for the scientific user
and a powerful framework for the visualization researcher. OpenWalnut is
and a powerful framework for the visualization researcher. OpenWalnut is
licensed under the terms of the GNU Lesser General Public License. Written
entirely in Standard C++ and using a number of portable libraries (e.g.
OpenSceneGraph and Qt), it runs on all Windows platforms, OSX, and
GNU/Linux operating systems.
- please refer to http://www.openwalnut.org for extensive documentation
- Please refer to http://www.openwalnut.org for extensive documentation
and information.
# AUTHORS AND CONTRIBUTORS
......@@ -19,47 +19,44 @@ See the files "AUTHORS" and "CONTRIBUTORS".
# LICENSE
OpenWalnut is licensed under the terms of the LGPLv3.
See "COPYING" and "COPYING.LESSER".
See the "COPYING" and "COPYING.LESSER" files.
# CONTACT
If you have questions, comments, problems or find Bugs, contact us using:
* Mailing list: openwalnut@lists.informatik.uni-leipzig.de
* Very low traffic at the moment ( < 1 mail per month), you might want to try
* **Mailing list**: openwalnut@lists.informatik.uni-leipzig.de
* Very low traffic at the moment ( < 1 mail per month). You might want to try
the developer mailing list below.
* To join the list visit
http://lists.informatik.uni-leipzig.de/mailman/listinfo/openwalnut and follow
the instructions.
* Developer Mailing list: openwalnut-dev@lists.informatik.uni-leipzig.de
* Medium traffic ( < 10 mails per week).
* To join the list visit
http://lists.informatik.uni-leipzig.de/mailman/listinfo/openwalnut-dev and
follow the instructions.
* IRC: Occasionally you can contact us at irc.freenode.net #ow.
* To join the list visit http://lists.informatik.uni-leipzig.de/mailman/listinfo/openwalnut and follow the instructions.
* **Developer Mailing list**: openwalnut-dev@lists.informatik.uni-leipzig.de
* Medium traffic ( < 10 mails per week).
* To join the list visit http://lists.informatik.uni-leipzig.de/mailman/listinfo/openwalnut-dev and follow the instructions.
# INSTALLING
You have several options for installing OpenWalnut.
* Build it -> see next section
* Download a binary archive from our website and extract it
* Build it -> see next section
* Download a binary archive from our website and extract it
* Inside the extracted directory, run bin/openwalnut
* Download one of our binary packages for your distribution
* Check the NeuroDebian repository
* We are currently working on a OpenWalnut package which is intended to be
* Download one of our binary packages for your distribution
* Check the NeuroDebian repository
* We have been working on a OpenWalnut package which has been
released in NeuroDebian (http://neuro.debian.net/)
# BUILDING
As you currently read this README, we presume that you already have the source.
If not, check http://www.openwalnut.org. There, you can download source archives
and get the URL to our mercurial repository.
and get the URL to our git repository.
## Required Dependencies:
* Qt4 (>= 4.6)
* Preferrably Qt4, build support also for Qt4 (>= 4.6)
* OpenSceneGraph (>= 2.8.0)
* Boost (>= 1.42.0)
* Boost (>= 1.46.0)
## Compilation on Unix-like systems:
......@@ -78,14 +75,14 @@ After that, OpenWalnut can be used inside the build directory.
If you want to install only a part of OpenWalnut, you can issue
```sh
make list_install_tarets
make list_install_targets
```
The listed targets will then only install the specified part.
## Compilation on Windows and Mac:
This is a little bit more complicated. We give you a step-by-step explanation
This is a little bit more complicated. We provide a step-by-step explanation
on http://www.openwalnut.org.
# BINARY DISTRIBUTION
......@@ -107,5 +104,4 @@ information is available online at http://www.openwalnut.org
If you want to develop modules for OpenWalnut, have a look at
src/modules/template, which contains an extensively documented example module.
More information is available online. The wiki, especially the development
section, is very helpful. Besides this, an online API documentation is available
at http://api.openwalnut.org.
section, is very helpful.
......@@ -78,7 +78,7 @@ ENDIF()
# ---------------------------------------------------------------------------------------------------------------------------------------------------
# some convenience install targets:
ADD_CUSTOM_TARGET( list_install_tarets
ADD_CUSTOM_TARGET( list_install_targets
COMMAND echo The following components can be installed:
COMMAND echo " * install - install everything."
COMMAND echo " * install_runtime - install the UIs."
......
......@@ -360,7 +360,7 @@ ELSE()
ENDIF()
# -----------------------------------------------------------------------------------------------------------------------------------------------
# OpenSceneGraph, at least 2.8.0
# OpenSceneGraph
# See http://www.openscenegraph.org
# find the needed packages
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment