Create README.md (#44)

Add a Readme with basic info.
pyanodon · Jan 31, 2024 · 34e02e7 · 34e02e7
1 parent 8c2b051
commit 34e02e7
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,17 @@
+# pY Post-processing
+## Bug Reports and Feedback
+
+Please use a dedicated repository [pybugreports](https://github.com/pyanodon/pybugreports) for bug reports and feedback.
+
+## Contributing
+
+When making a Pull Request, please also update `changelog.txt` with the summary of your changes.  
+If there is no upcoming version in the file, then the format is as follows:
+```
+---------------------------------------------------------------------------------------------------
+Version: a.b.c
+Date: ???
+  Changes:
+    - The summary of your changes
+---------------------------------------------------------------------------------------------------
+```