Merge pull request #48 from torbjoernk/feature/add-changelog

add Changelog file

Author: memmett

CHANGELOG.md

@@ -0,0 +1,33 @@
+# Changelog                                                                        {#page_changelog}
+
+## v0.1.0 -- First Release (2014/07/25)
+
+DOI: [10.5281/zenodo.11047](http://dx.doi.org/10.5281/zenodo.11047)
+
+### Notable Features
+
+* Initial release with basic implementations of SDC and MLSDC
+
+### Details
+
+* agreed on code style guideline using Astyle tool
+  ([#2][], [#15][], [#21][], [#22][])
+* few test cases for quadrature and advection-diffusion example
+  ([#23][], [#25][], [#33][], [#37][])
+
+[#2]: https://github.com/Parallel-in-Time/PFASST/pull/2
+[#15]: https://github.com/Parallel-in-Time/PFASST/pull/15
+[#21]: https://github.com/Parallel-in-Time/PFASST/pull/21
+[#22]: https://github.com/Parallel-in-Time/PFASST/pull/22
+[#23]: https://github.com/Parallel-in-Time/PFASST/pull/23
+[#25]: https://github.com/Parallel-in-Time/PFASST/pull/25
+[#33]: https://github.com/Parallel-in-Time/PFASST/pull/33
+[#37]: https://github.com/Parallel-in-Time/PFASST/pull/37
+
+### Contributors
+
+* Matthew Emmett, Lawrence Berkeley National Laboratory ([memmett][])
+* Torbjörn Klatt, Jülich Supercomputing Centre ([torbjoernk][])
+
+[memmett]: https://github.com/memmett
+[torbjoernk]: https://github.com/torbjoernk

Doxyfile

@@ -666,7 +666,7 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
-INPUT                  = include tests examples doc/source README.md
+INPUT                  = include tests examples doc/source README.md CHANGELOG.md
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is

README.md

@@ -1,21 +1,19 @@
-PFASST                                                                                  {#mainpage}
+PFASST                                                                                   {#mainpage}
 ======
 
-The PFASST algorithm is a time-parallel algorithm for solving ODEs and
-PDEs.
+The PFASST algorithm is a time-parallel algorithm for solving ODEs and PDEs.
 
-The PFASST project is a C++ implementation of the 'parallel full
-approximation scheme in space and time' (PFASST) algorithm.  It also
-contains basic implementations of the 'spectral deferred correction'
-(SDC) and 'multi-level spectral deferred correction' (MLSDC)
-algorithms.
+The PFASST project is a C++ implementation of the *parallel full approximation scheme in space and 
+time* (PFASST) algorithm.
+It also contains basic implementations of the *spectral deferred correction* (SDC) and 
+*multi-level spectral deferred correction* (MLSDC) algorithms.
 
 
 News
 ----
 
-* July 25, 2014: PFASST v0.1.0 released.  Please see the [release
-  notes](#releases) for more information.
+* July 25, 2014: PFASST v0.1.0 released.  Please see the [release notes](#releases) for more 
+  information.
 
 
 References
@@ -39,11 +37,21 @@ Currently, it features the following content:
 Releases
 --------
 
-* **v0.1.0** Initial release with basic implementations of SDC and MLSDC.
+* **v0.1.0** First Release (2014/07/25)
+
+  Initial release with basic implementations of SDC and MLSDC.  
+  DOI: [10.5281/zenodo.11047][DOI_v010]  
+  See \subpage #page_changelog "the Changelog" for details.
+
+[DOI_v010]: http://dx.doi.org/10.5281/zenodo.11047
+
+Release tags will be signed by one of the following PGP keys:
+
+    0x9CF9601F 2011-07-28 Torbjörn Klatt <[email protected]>
+    Fingerprint DB8D EA65 F6A7 3DE0 E7EA F607 6CE8 B4B1 9CF9 601F
 
 
 Build status
-------------
 
 | Branch      | Status                              |
 |-------------|-------------------------------------|