Commit 2c9a6da1 authored by Dave Moxey's avatar Dave Moxey

Convert README to markdown

parent 852003d6
......@@ -8,8 +8,7 @@ This package consists of a set of libraries (the framework) and a number of
pre-written PDE solvers for a selection of application domains.
The software and User Guide is available for download from
http://www.nektar.info
<http://www.nektar.info/>.
User Guide
----------
......@@ -21,8 +20,10 @@ from the downloads section of the project website.
Pre-requisites
--------------
Nektar++ requires the following software to be installed on the users system:
- CMake
- BLAS/LAPACK
- CMake
- BLAS/LAPACK
Additional software is also required. This can either be installed system-wide
or it can be downloaded and compiled automatically during the build process.
......@@ -31,15 +32,16 @@ For more detailed information, please see the User Guide.
Compilation
-----------
On most UNIX-based systems a default compilation can be performed using the following commands from the top-level of the source tree:
On most UNIX-based systems a default compilation can be performed using the
following commands from the top-level of the source tree:
mkdir build
cd build
cmake ..
make
mkdir build
cd build
cmake ..
make
To alter the build configuration (for example, to enable parallel execution
support) we recommend using the 'ccmake' command instead of 'cmake'.
support) we recommend using the `ccmake` command instead of `cmake`.
For more detailed operating-system specific instructions, please see the
User Guide.
......@@ -47,10 +49,9 @@ User Guide.
Installation
------------
The default installation location is in a 'dist' subdirectory of the 'build'
directory. This can be changed by setting the 'CMAKE_INSTALL_PREFIX' option
using 'ccmake'. To install the compiled libraries, solvers and header files, on
The default installation location is in a `dist` subdirectory of the `build`
directory. This can be changed by setting the `CMAKE_INSTALL_PREFIX` option
using `ccmake`. To install the compiled libraries, solvers and header files, on
UNIX-based systems run:
make install
make install
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