Merge pull request #187 from chipmuenk/license_info

License info

AUTHORS.md

@@ -1,52 +1,17 @@
-Authors
-=======
+### Authors
 
 [pyFDA][home] is written and maintained by Christian Muenker,
 along with the contributors on [github](https://github.com/chipmuenk/pyfda) .
 
-Special thanks:
-~~~~~~~~~~~~~~~
+#### Special thanks:
 
-- [@endolith](https://github.com/endolith) for his [bandlimited periodic functions](https://gist.github.com/endolith/407991)
+- [@endolith](https://github.com/endolith) a.o. or his [bandlimited periodic functions](https://gist.github.com/endolith/407991)
 - [sbourdeauducq](https://github.com/sbourdeauducq) for discussions and support on [migen](https://github.com/m-labs/migen)
 - [@cfelton](https://github.com/cfelton) for a lot of discussions on fixpoint simulations and [myhdl](http://myhdl.org/)
 - [@sriyash25](https://github.com/sriyash25) for his contributions on fixpoint filters during the GSoC 2018
 
 
-[home]: README_PYPI.md
-
-
-External modules and libraries
-==============================
-
-pyFDA itself is licensed under the permissive MIT license. The source code is
-released at the Github repository [chipmuenk/pyfda](https://github.com/chipmuenk/pyfda).
-
-However, when using
-binary distribution, several external libraries and icons come bundled with the binary.
-
-Most included software has BSD-style licenses, i.e. MIT or PSF (Python Software Foundation)
-with the notable exception of the Qt5 and PyQt libraries.
-Please send me message if I've '
-
-
-| Module | Licence | Purpose |
-==============================
-| Python | PSF     |
-| [numpy](https://numpy.org/) | BSD | Base package for fast array numerics|
-| [scipy](https://www.scipy.org/)  | BSD | | Library for scientific computing |
-| [numexpr](https://github.com/pydata/numexpr) | MIT | Fast numerical array expression|
-| [matplotlib](https://matplotlib.org/) | PSF-based | Plotting library |
-| Qt5    | LPGL | Widget library (UI etc.) |
-| PyQt | GPL | Python wrapper for Qt5 |
-| docutils | |
-| migen |  | Fixpoint simulation and synthesis |
-| nMigen |  | Fixpoint simulation and synthesis |
-| mplcursors | | Interactive cursors |
-| pyInstaller | GPL 2.0  |Packager for distributing the binary |
-
-https://velovix.github.io/post/lgpl-gpl-license-compliance-with-pyinstaller/
-
 Icons (except the pyFDA icon) are taken from the "Open Iconic" Icons collection 
 at  [https://useiconic.com/open/](https://useiconic.com/open/) under MIT license.
 
+[home]: README_PYPI.md

CHANGELOG.md

@@ -1,12 +1,13 @@
-# Changelog
+## Changelog
 
-## [v0.4.0](https://github.com/chipmuenk/pyfda/tree/v0.3.2) (2020-09-xx)
+### [v0.4.0](https://github.com/chipmuenk/pyfda/tree/v0.4.0) (2020-10-xx)
 
-**Bug Fixes**
+#### Bug Fixes
 - Make compatible to matplotlib 3.3 by cleaning up hierarchy for NavigationToolbar in mpl_widgets.py
- [(Issue \#179)](https://github.com/chipmuenk/pyfda/issues/179) and get rid of mpl 3.3 related deprecation warnings. Disable zoom rectangle and pan when zoom is locked. 
+ ([Issue \#179](https://github.com/chipmuenk/pyfda/issues/179), [Issue \#44](https://github.com/chipmuenk/pyfda/issues/144)) 
+  and get rid of mpl 3.3 related deprecation warnings. Disable zoom rectangle and pan when zoom is locked. 
 
-- [PR \#182:](https://github.com/chipmuenk/pull/182) Get rid of deprecation warnings "Creating an ndarray from ragged nested sequences"  [(Issue \#180)](https://github.com/chipmuenk/pyfda/issues/180)
+- [PR \#182:](https://github.com/chipmuenk/pyfda/pull/182) Get rid of deprecation warnings "Creating an ndarray from ragged nested sequences"  [(Issue \#180)](https://github.com/chipmuenk/pyfda/issues/180)
   by declaring explicitly np.array(some_ragged_list , dtype=object) or by handling the elements of ragged list indidually
   ([chipmuenk](https://github.com/chipmuenk))
 
@@ -21,19 +22,27 @@
 
 - Enforce correct sign for various input fields
 
-**Enhancements**
+#### Enhancements
 
-- Add cursor / annotations in plots [(Issue \#112)](https://github.com/chipmuenk/issues/112) This is only available when [mplcursors](https://mplcursors.readthedocs.io/) module is installed and for matplotlib >= 3.1.
+- Include license information for distribution of pyFDA as source code and in bundled form, redesign the whole 
+  about window
+
+- Add cursor / annotations in plots ([Issue \#112](https://github.com/chipmuenk/pyfda/issues/112)) This is only available when 
+  [mplcursors](https://mplcursors.readthedocs.io/) module is installed and for matplotlib >= 3.1.
 
-- [PR \#183:](https://github.com/chipmuenk/pull/183) Replace simpleeval library by numexpr. 
-  This enables the creation of formula based stimuli, closing [Issue \#162](https://github.com/chipmuenk/issues/162)
+- [PR \#183:](https://github.com/chipmuenk/pyfda/pull/183) Replace simpleeval library by numexpr. 
+  This enables the creation of formula based stimuli, closing [Issue \#162](https://github.com/chipmuenk/pyfda/issues/162) and 
+  part of [Issue \#44](https://github.com/chipmuenk/pyfda/issues/144).
 
 - Add chirp stimulus in Impulse Response tab.
 
 - The top level module name for generated Verilog netlists (Fixpoint tab) is now derived from the
   specified file name. The module name is converted to lower cased and sanitized so that is only 
-  contains alpha-numeric characters and '_'.  ([(Issue \#176)](https://github.com/chipmuenk/pyfda/issues/176), 
+  contains alpha-numeric characters and '_'.  [(Issue \#176)](https://github.com/chipmuenk/pyfda/issues/176), 
   "allow different module names for verilog export").
+
+- User and user log config files now can be replaced automatically if the config file version number is wrong 
+   ([Issue \#44](https://github.com/chipmuenk/pyfda/issues/144))
 
 - Add CHANGELOG.md (this file)
 

LICENSE.txt → LICENSE.md

@@ -1,7 +1,7 @@
-pyFDA License Agreement (MIT License)
---------------------------------------
+### MIT License
 
-Copyright (c) 2014- The pyFDA Development Team
+
+**Copyright (c) 2013 - 2020** pyFDA Development Team and others (see AUTHORS.md)
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation
@@ -25,20 +25,4 @@ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 OTHER DEALINGS IN THE SOFTWARE.
 
 
-Included software
------------------
-
-License terms are included in any software used inside pyFDA's source code.
-
-
-Included images (pyfda/images)
-----------------------------------
-
-[1] pyFDA License Agreement (see above)
-
-pyfda/images/icons/pyfda_icon.odt
-pyfda/images/icons/pyfda_icon.png
-pyfda/images/icons/pyfda_icon.svg
-
-