Skip to content

Commit c4815a4

Browse files
committed
docs - add release notes
1 parent 5b1981d commit c4815a4

File tree

4 files changed

+41
-1
lines changed

4 files changed

+41
-1
lines changed

RELEASE_NOTES.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
See release notes in ``docs/src/release_notes.md``

docs/make.jl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ makedocs(
3030
"Examples" => "examples.md",
3131
"Public API" => "public.md",
3232
"Private API" => "private.md",
33+
"Release Notes" => "release_notes.md",
3334
"References" => "references.md",
3435
],
3536
clean = false,

docs/src/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@ Pages = [
2323
"examples.md",
2424
"public.md",
2525
"private.md",
26+
"release_notes.md",
2627
"references.md"
2728
]
2829
Depth = 1
29-
```
30+
```

docs/src/release_notes.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Release Notes
2+
3+
## Development
4+
5+
The current main branch includes updated functionality and an improved interface.
6+
7+
Functionality updates include:
8+
9+
* Macro-element bases consisting of multiple micro-elements
10+
* Chebyshev preconditioning analysis
11+
* H-multigrid analysis
12+
13+
Interface improvements include:
14+
15+
* Multi-component basis support simplified
16+
17+
Additonal changes include:
18+
19+
* Improved documentation
20+
* Expanded examples, to include Neo-Hookean hyperelasticity
21+
* Rename primary branch to `main`
22+
23+
## v0.1.1
24+
25+
Minor bugfixes
26+
27+
## v0.1
28+
29+
This release includes initial basic functionality of LFAToolkit.
30+
31+
Functionality includes:
32+
33+
* User defined second order PDEs
34+
* Abritrary basis order, dimension, and number of components
35+
* Independent mesh scaling in each dimension
36+
* Jacobi preconditioning analysis
37+
* P-multigrid analysis

0 commit comments

Comments
 (0)