Skip to content

Commit

Permalink
Add changelog
Browse files Browse the repository at this point in the history
in preparation for release of v0.2
  • Loading branch information
formatc1702 committed Jul 11, 2020
1 parent 9e11051 commit 0cef5e3
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 1 deletion.
29 changes: 29 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Change Log

## [0.2](https://github.com/formatc1702/WireViz/tree/v0.2) (2020-XX-XX)

### Backward incompatible 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))

### New 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
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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)

0 comments on commit 0cef5e3

Please sign in to comment.