Merge pull request #32 from trixi-framework/add-news-md

Increase version to v0.3 and add NEWS.md

NEWS.md

@@ -0,0 +1,39 @@
+# Changelog
+
+Trixi2Vtk.jl follows the interpretation of
+[semantic versioning (semver)](https://julialang.github.io/Pkg.jl/dev/compatibility/#Version-specifier-format-1)
+used in the Julia ecosystem. Notable changes will be documented in this file
+for human readability.
+
+
+## Changes in the v0.3 lifecycle
+
+#### Added
+
+
+#### Changed
+
+
+#### Deprecated
+
+
+#### Removed
+
+
+## Changes in v0.3
+
+#### Added
+
+- Visualize solutions obtained on 2D unstructured quadrilateral meshes (`UnstructuredQuadMesh`)
+- Visualize solutions obtained on 2D and 3D structured curved meshes (`CurvedMesh`)
+
+#### Changed
+
+- The required Julia version is updated to v1.6.
+
+#### Deprecated
+
+
+#### Removed
+
+- Ability to read and visualize solution files generated by Trixi prior to v0.3.

Project.toml

@@ -1,7 +1,7 @@
 name = "Trixi2Vtk"
 uuid = "bc1476a1-1ca6-4cc3-950b-c312b255ff95"
 authors = ["Michael Schlottke-Lakemper <[email protected]>"]
-version = "0.2.5-pre"
+version = "0.3.0"
 
 [deps]
 Glob = "c27321d9-0574-5035-807b-f59d2c89b15c"

README.md

@@ -4,7 +4,7 @@
 [![Build Status](https://github.com/trixi-framework/Trixi2Vtk.jl/workflows/CI/badge.svg)](https://github.com/trixi-framework/Trixi2Vtk.jl/actions?query=workflow%3ACI)
 [![Coveralls](https://coveralls.io/repos/github/trixi-framework/Trixi2Vtk.jl/badge.svg?branch=main)](https://coveralls.io/github/trixi-framework/Trixi2Vtk.jl?branch=main)
 [![License: MIT](https://img.shields.io/badge/License-MIT-success.svg)](https://opensource.org/licenses/MIT)
-[![GitHub commits since tagged version](https://img.shields.io/github/commits-since/trixi-framework/Trixi2Vtk.jl/v0.2.4.svg?style=social&logo=github)](https://github.com/trixi-framework/Trixi2Vtk.jl)
+[![GitHub commits since tagged version](https://img.shields.io/github/commits-since/trixi-framework/Trixi2Vtk.jl/v0.3.0.svg?style=social&logo=github)](https://github.com/trixi-framework/Trixi2Vtk.jl)
 
 With **Trixi2Vtk.jl** you can convert the HDF5-based output files created by
 [Trixi.jl](https://github.com/trixi-framework/Trixi.jl) (solution or restart
@@ -25,6 +25,14 @@ the following commands in the Julia REPL:
 julia> import Pkg; Pkg.add("Trixi2Vtk")
 ```
 
+To update an existing installation of Trixi2Vtk to the
+[latest release](https://github.com/trixi-framework/Trixi2Vtk.jl/releases/latest),
+execute
+```julia
+julia> import Pkg; Pkg.update("Trixi2Vtk"); Pkg.status("Trixi2Vtk")
+```
+in the Julia REPL. A brief list of notable changes to Trixi2Vtk is available in
+[`NEWS.md`](NEWS.md).
 
 ## Usage
 In the Julia REPL, first load the package Trixi2Vtk