Commit 3b15b820 authored by Chris Cantwell's avatar Chris Cantwell

Updated changelog, contributing and readme docs.

parent d63304c9
......@@ -43,6 +43,9 @@ v4.3.0
- Add linearise processing module to remove all curvature from high order
elements (!509)
**Documentation:**
- Added git submodule for including Nektar++ tutorials in the source tree (!507)
v4.2.0
------
......
......@@ -128,6 +128,12 @@ should provide:
- Generally, code should be well-commented using regular C++ comments to explain
its function to help in reviewing it.
Nektar++ also has a growing number of tutorials to help introduce users and
developers to the use of the library and the range of application solvers. These
are stored in a separate repository, but are available from the main repository
through a git submodule. To populate the docs/tutorial directory run `git
submodule init` followed by `git submodule update`.
## Code review and merging
All merge requests will be reviewed by one of the senior developers. We try to
stick to the following process:
......
......@@ -10,6 +10,7 @@ pre-written PDE solvers for a selection of application domains.
The software and User Guide is available for download from
<http://www.nektar.info/>.
User Guide
----------
Detailed information on compiling, installing and using the software is
......@@ -17,6 +18,15 @@ available in the User Guide. This document is available as a pre-compiled PDF
from the downloads section of the project website.
Tutorials
---------
A number of tutorials are available, designed to walk the user through the
basics of spectral/hp element methods, through the use of individual solvers and
performing specific types of calculations.
The tutorials are available from <http://doc.nektar.info/tutorials/latest>.
Pre-requisites
--------------
Nektar++ requires the following software to be installed on the users system:
......
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