From 753430036fbc682f44d21a18c76d87c7978d1b0c Mon Sep 17 00:00:00 2001 From: Daniel Rojas Date: Sat, 11 Jul 2020 14:57:03 +0200 Subject: [PATCH] Add changelog in preparation for release of v0.2 --- CHANGELOG.md | 29 +++++++++++++++++++++++++++++ README.md | 8 +++++++- 2 files changed, 36 insertions(+), 1 deletion(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..d951476a --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,29 @@ +# Change Log + +## [0.2](https://github.com/formatc1702/WireViz/tree/v0.2) (2020-XX-XX) + +### Breaking changes + +- Change names of connector attributes ([#77](https://github.com/formatc1702/WireViz/issues/77)) +- Remove ferrules as a separate connector type ([#78](https://github.com/formatc1702/WireViz/issues/78)) +- Change the way loops are defined ([#79](https://github.com/formatc1702/WireViz/issues/79)) + +### Features +- Add bidirectional AWG/mm2 conversion ([#41](https://github.com/formatc1702/WireViz/pull/41)) +- Add support for part numbers ([#11](https://github.com/formatc1702/WireViz/pull/11)) +- Add support for multicolored wires ([#17](https://github.com/formatc1702/WireViz/pull/17)) +- Add ability to export data directly to other programs ([#55](https://github.com/formatc1702/WireViz/pull/55)) +- Add support for line breaks in various fields ([#63](https://github.com/formatc1702/WireViz/issues/63)) +- Allow using connector pin names to define connections ([#72](https://github.com/formatc1702/WireViz/issues/72)) +- Make defining connection sets easier and more flexible ([#67](https://github.com/formatc1702/WireViz/issues/67)) + +### Misc. fixes + +- Improve BOM generation +- Add various input sanity checks + +### + +## [0.1](https://github.com/formatc1702/WireViz/tree/v0.1) (2020-06-29) + +- Initial release diff --git a/README.md b/README.md index b96dd42c..22c9a491 100644 --- a/README.md +++ b/README.md @@ -110,7 +110,13 @@ If you would like to rebuild all of the included demos, examples and tutorials, ```cd src/wireviz ./build_examples.py + ``` + +## Changelog + +See [CHANGELOG.md](CHANGELOG.md) + ## Status This is very much a [work in progress](https://github.com/formatc1702/WireViz/projects/1). Source code, API, syntax and functionality may change wildly at any time. @@ -123,4 +129,4 @@ Ubuntu 18.04 LTS users in particular may need to separately install Python 3.7 o ## License -GNU GPLv3 +[GPL-3.0](LICENSE)