Skip to content
Permalink
Browse files

minor readme and manual update

  • Loading branch information
braunms committed Jan 9, 2020
1 parent 194ac32 commit 1d2539d77cd99dc6a94b9e13b0cb2438682786fa
Showing with 13 additions and 6 deletions.
  1. +7 −2 Readme.md
  2. +6 −4 docs/manual.md
@@ -9,6 +9,10 @@ MegaMol is a visualization middleware used to visualize point-based molecular da
MegaMol succeeds ​MolCloud, which has been developed at the University of Stuttgart in order to visualize point-based data sets. MegaMol is written in C++, and uses an OpenGL as Rendering-API and GLSL-Shader. It supports the operating systems Microsoft Windows and Linux, each in 32-bit and 64-bit versions. In large parts, MegaMol is based on VISlib, a C++-class library for scientific visualization, which has also been developed at the University of Stuttgart.


## Changelog
​See [changelog](https://github.com/UniStuttgart-VISUS/megamol/wiki/Changelog) for newly available features in the current version of MegaMol.


## Building MegaMol
### Linux
1. Clone the MegaMol repository
@@ -18,7 +22,8 @@ MegaMol succeeds ​MolCloud, which has been developed at the University of Stut
5. Run `make install` to create your MegaMol installation
6. Test Megamol with

./megamol.sh -p ..\examples\testspheres.lua
$./megamol.sh -p ../examples/testspheres.lua


### Windows
1. Clone the MegaMol repository
@@ -29,7 +34,7 @@ MegaMol succeeds ​MolCloud, which has been developed at the University of Stut
5. Use the `INSTALL` target to create your MegaMol installation
6. Test Megamol with

mmconsole.exe -p ..\examples\testspheres.lua
>mmconsole.exe -p ..\examples\testspheres.lua

## MegaMol Configurator
@@ -22,7 +22,7 @@ The MegaMol project was started in the Collaborative Research Center 716, subpro
Today, it is governed by a number of teams at the TU Dresden and the University of Stuttgart.

The goal of the project is to provide a software base for visualization research and to provide a stable environment to deploy newest visualization prototypes to application domain researchers. MegaMol is not a visualization tool. MegaMol is a platform for visualization research.
Visit the project [website](https://github.com/UniStuttgart-VISUS/megamol.git "Megamol homepage") for downloads and more information.
Visit the project [website](https://github.com/UniStuttgart-VISUS/megamol.git "Megamol Homepage") for downloads and more information.

### License

@@ -51,7 +51,7 @@ Further platforms are not considered during the development. While MegaMol might

#### Windows

For Windows, you have to install (CMake)[https://cmake.org/], and load the `CMakeLists.txt` present in the root directory of the repository.
For Windows, you have to install [CMake](https://cmake.org/), and load the `CMakeLists.txt` present in the root directory of the repository.
Next, click `Configure` a few times (until all red entries disappear).
Then click `Generate` to generate the build files.

@@ -200,7 +200,8 @@ Test your installation following the description in the following section.
The test MegaMol simple start the front end executable. Open a console and change your working directory to the MegaMol install directory. Start
the MegaMol start script:

./megamol.sh
LINUX$ ./megamol.sh
WINDOWS> mmconsole.exe

The resulting output should look something like this:

@@ -254,7 +255,8 @@ Alternatively, you can descend into the bin directory and start the front end di
This direct invocation is not recommended. Thus, the remaining examples in this manual will assume that you use the start shell script. MegaMol should start and print several messages to the console. The leading number of each line is the log level. There should be no output of warnings (log level of 100 or less) or errors (log level 1). The output should match the one above. For a better test, you should invoke MegaMol requesting a simple rendering. Then you can be sure that the graphics drivers, graphics libraries, and shader codes are correctly found and are working. To do this, try:
$ ./megamol.sh -i testspheres inst
LINUX$ ./megamol.sh -p ../examples/testspheres.lua
WINDOWS> mmconsole.exe -p ..\examples\testspheres.lua
<center>
<a name="testrunpic"></a>

0 comments on commit 1d2539d

Please sign in to comment.
You can’t perform that action at this time.