From bac4a52dd8b24f7e6a049c84d34c568ea83e5348 Mon Sep 17 00:00:00 2001 From: "Adam J. Jackson" Date: Thu, 28 Jul 2016 10:01:03 +0100 Subject: [PATCH] Add changelog --- CHANGELOG.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..5d4bafd --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,36 @@ +# Change Log + +Notable changes are logged here by release. This project is not +expected to be especially active and follows a simplified Semantic Versioning: + +- Version numbers take the format X.Y +- X is associated with major API breakage / changes in algorithm and results. +- Y is associated with minor updates and improvements +- Small amounts of code tidying, refactoring and documentation do not + lead to a new release, and simply sit on the Development branch of + the Git repository. + +The changelog format is inspired by [keep-a-changelog](https://github.com/olivierlacan/keep-a-changelog). + +## [Unreleased] + + +## [0.2] - 2016-07-28 + +### Added +- Present useful Python API for use with [Atomic Simulation Environment (ASE)](https://wiki.fysik.dtu.dk/ase/) calculators + +### Changed +- Import routine uses [Atomic Simulation Environment](https://wiki.fysik.dtu.dk/ase/). This adds a + dependency, but permits import of almost any major crystal structure + file format. + +## 0.1 - 2013-06-01 + +### Added +- Basic codebase reading from FHI-aims input files +- Optparse-based interface +- GPL + +[Unreleased]: http://github.com/wmd-group/kgrid/compare/v0.2...HEAD +[0.2]: http://github.com/wmd-group/kgrid/compare/v0.1...v0.2