Merge pull request #22 from boutproject/whats-new

Create doc/whats-new.md

.github/pull_request_template.md

@@ -0,0 +1,8 @@
+<!--
+Please run flake8 and black on your changes, these will be checked by the CI.
+Feel free to remove any of the check-list items that aren't relevant to your PR.
+-->
+
+- [ ] Closes #xxxx
+- [ ] Tests added
+- [ ] Updated `doc/whats-new.md` with a summary of the changes

doc/whats-new.md

@@ -0,0 +1,52 @@
+What's new
+==========
+
+
+0.1.0 (24th April 2020)
+-----------------------
+
+### New Features
+
+- Github Action to upload hypnotoad to PyPi on release (#19)\
+  By [John Omotani](https://github.com/johnomotani)
+
+- Version number auto-detected from git tags using versioneer (#18)\
+  By [John Omotani](https://github.com/johnomotani)
+
+- Graphical user interface, using Qt.py (#17)\
+  By [Peter Hill](https://github.com/ZedThree)
+
+- Github Actions automatically run pytest, flake8 and black (#10)\
+  By [John Omotani](https://github.com/johnomotani)
+
+- Support for tokamak grids (#2)\
+  By [Ben Dudson](https://github.com/bendudson)
+
+
+### Bug fixes
+
+- Set wall=[] instead of wall=None when there is no wall (#12 #9)
+  By [John Omotani](https://github.com/johnomotani)
+
+
+### Documentation
+
+- doc/whats-new.md documents changes (#22)\
+  By [John Omotani](https://github.com/johnomotani)
+
+- doc/developer/RELEASE\_HOWTO.md specifies release process
+  By [John Omotani](https://github.com/johnomotani)
+
+
+### Internal changes
+
+- Rename package and repo from 'hypnotoad2' to 'hypnotoad' (#21)\
+  By [John Omotani](https://github.com/johnomotani)
+
+
+0.0.0 (24th March 2020)
+-------------------
+
+Python grid generator for BOUT++, supporting orthogonal or non-orthogonal
+grids. Working for TORPEX X-point configuration.
+By [John Omotani](https://github.com/johnomotani)