diff --git a/CHANGELOG.md b/CHANGELOG.md index 391491556548ae2bf94083314d9c367acf4138d2..09655d0b4ae05c0d1271b5fbe7aeeea580fb65ef 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 ------ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0918595c0569b2f7659136a16efce9345ad035dc..ca62f6be63a5a95afaaec97463d87089c70ec236 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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: diff --git a/README.md b/README.md index 12f0eeb1f7678814490cdda00c7962347901b41e..32024525a1728d1554786d3753d939b0f27fa654 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ pre-written PDE solvers for a selection of application domains. The software and User Guide is available for download from . + 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 . + + Pre-requisites -------------- Nektar++ requires the following software to be installed on the users system: