Skip to content

Commit 6dd97d7

Browse files
committed
creating CHANGELOG file
1 parent 0014672 commit 6dd97d7

File tree

3 files changed

+54
-13
lines changed

3 files changed

+54
-13
lines changed

CHANGELOG.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Changelog {#page_changelog}
2+
3+
## v0.1.0 -- First Release (2014/07/25)
4+
5+
DOI: [10.5281/zenodo.11047](http://dx.doi.org/10.5281/zenodo.11047)
6+
7+
### Notable Features
8+
9+
* Initial release with basic implementations of SDC and MLSDC
10+
11+
### Details
12+
13+
* agreed on code style guideline using Astyle tool
14+
([#2][], [#15][], [#21][], [#22][])
15+
* few test cases for quadrature and advection-diffusion example
16+
([#23][], [#25][], [#33][], [#37][])
17+
18+
[#2]: https://github.com/Parallel-in-Time/PFASST/pull/2
19+
[#15]: https://github.com/Parallel-in-Time/PFASST/pull/15
20+
[#21]: https://github.com/Parallel-in-Time/PFASST/pull/21
21+
[#22]: https://github.com/Parallel-in-Time/PFASST/pull/22
22+
[#23]: https://github.com/Parallel-in-Time/PFASST/pull/23
23+
[#25]: https://github.com/Parallel-in-Time/PFASST/pull/25
24+
[#33]: https://github.com/Parallel-in-Time/PFASST/pull/33
25+
[#37]: https://github.com/Parallel-in-Time/PFASST/pull/37
26+
27+
### Contributors
28+
29+
* Matthew Emmett, Lawrence Berkeley National Laboratory ([memmett][])
30+
* Torbjörn Klatt, Jülich Supercomputing Centre ([torbjoernk][])
31+
32+
[memmett]: https://github.com/memmett
33+
[torbjoernk]: https://github.com/torbjoernk

Doxyfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -666,7 +666,7 @@ WARN_LOGFILE =
666666
# directories like "/usr/src/myproject". Separate the files or directories
667667
# with spaces.
668668

669-
INPUT = include tests examples doc/source README.md
669+
INPUT = include tests examples doc/source README.md CHANGELOG.md
670670

671671
# This tag can be used to specify the character encoding of the source files
672672
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is

README.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,19 @@
1-
PFASST {#mainpage}
1+
PFASST {#mainpage}
22
======
33

4-
The PFASST algorithm is a time-parallel algorithm for solving ODEs and
5-
PDEs.
4+
The PFASST algorithm is a time-parallel algorithm for solving ODEs and PDEs.
65

7-
The PFASST project is a C++ implementation of the 'parallel full
8-
approximation scheme in space and time' (PFASST) algorithm. It also
9-
contains basic implementations of the 'spectral deferred correction'
10-
(SDC) and 'multi-level spectral deferred correction' (MLSDC)
11-
algorithms.
6+
The PFASST project is a C++ implementation of the *parallel full approximation scheme in space and
7+
time* (PFASST) algorithm.
8+
It also contains basic implementations of the *spectral deferred correction* (SDC) and
9+
*multi-level spectral deferred correction* (MLSDC) algorithms.
1210

1311

1412
News
1513
----
1614

17-
* July 25, 2014: PFASST v0.1.0 released. Please see the [release
18-
notes](#releases) for more information.
15+
* July 25, 2014: PFASST v0.1.0 released. Please see the [release notes](#releases) for more
16+
information.
1917

2018

2119
References
@@ -39,11 +37,21 @@ Currently, it features the following content:
3937
Releases
4038
--------
4139

42-
* **v0.1.0** Initial release with basic implementations of SDC and MLSDC.
40+
* **v0.1.0** First Release (2014/07/25)
41+
42+
Initial release with basic implementations of SDC and MLSDC.
43+
DOI: [10.5281/zenodo.11047][DOI_v010]
44+
See \subpage #page_changelog "the Changelog" for details.
45+
46+
[DOI_v010]: http://dx.doi.org/10.5281/zenodo.11047
47+
48+
Release tags will be signed by one of the following PGP keys:
49+
50+
0x9CF9601F 2011-07-28 Torbjörn Klatt <[email protected]>
51+
Fingerprint DB8D EA65 F6A7 3DE0 E7EA F607 6CE8 B4B1 9CF9 601F
4352

4453

4554
Build status
46-
------------
4755

4856
| Branch | Status |
4957
|-------------|-------------------------------------|

0 commit comments

Comments
 (0)