chore: changelog and project urls

CHANGELOG.md

@@ -0,0 +1,32 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Fixed
+
+- plot size
+- small fixes in `OMA.py` and `plot_func.py`
+
+### Added
+
+- methods to plot channels info
+- docstring on `SelFormPlot` class
+- jupyter notebook for `SingleSetup`
+
+
+## [0.1.0] - 2024-01-25
+
+### Added
+
+- Initial release of the project
+
+### Removed
+
+### Changed
+
+### Fixed

README.md

@@ -17,6 +17,29 @@ Please note that this is still an alpha release, and we are continuously refinin
 
 ## Quick start
 
+Install the library
+
+```shell
+pip install pyOMA-2
+```
+
+You'll probably need to install **tk** for the GUI on your system, here some instructions:
+
+Windows:
+
+https://www.pythonguis.com/installation/install-tkinter-windows/
+
+
+Linux:
+
+https://www.pythonguis.com/installation/install-tkinter-linux/
+
+Mac:
+
+https://www.pythonguis.com/installation/install-tkinter-mac/
+
+____
+
 To see example usage go to `pyoma2/Example*` files.
 
 To run them, after have installed the package you can do as follow:

pyproject.toml

@@ -20,6 +20,14 @@ readme = "README.md"
 license = {text = "MIT"}
 
 
+[project.urls]
+Homepage = "https://github.com/dagghe/pyOMA2"
+Documentation = "https://github.com/dagghe/pyOMA2/blob/main/README.md"
+Repository = "https://github.com/dagghe/pyOMA2"
+Changelog = "https://github.com/dagghe/pyOMA2/blob/main/CHANGELOG.md"
+Contributing = "https://github.com/dagghe/pyOMA2/blob/main/CONTRIBUTING.md"
+
+
 [build-system]
 requires = ["pdm-backend"]
 build-backend = "pdm.backend"