skpkg: readme

Author: TingwenZhang

.gitignore

@@ -10,6 +10,7 @@ __pycache__/
 .Python
 env/
 build/
+_build/
 develop-eggs/
 dist/
 downloads/
@@ -90,10 +91,3 @@ target/
 
 # Ipython Notebook
 .ipynb_checkpoints
-
-# version information
-setup.cfg
-/src/diffpy/*/version.cfg
-
-# Rever
-rever/

CHANGELOG.rst

@@ -1,5 +1,5 @@
 =============
-Release Notes
+Release notes
 =============
 
 .. current developments
@@ -28,7 +28,7 @@ Release Notes
 **Fixed:**
 
 * Add getting started section and re-arrange install success check instructions
-* Added termial script for transtru app in pyproject.toml
+* Added terminal script for transtru app in pyproject.toml
 * Changed requires-python to align with classifiers
 
 

LICENSE.rst

@@ -15,7 +15,7 @@ Copyright (c) 2014, Australian Synchrotron Research Program Inc., ("ASRP")
 
 Copyright (c) 2014-2019, Brookhaven Science Associates, Brookhaven National Laboratory
 
-Copyright (c) 2024, The Trustees of Columbia University in the City of New York.
+Copyright (c) 2024-2025, The Trustees of Columbia University in the City of New York.
 All rights reserved.
 
 The "DiffPy-CMI" is distributed subject to the following license conditions:

README.rst

@@ -8,7 +8,7 @@
         :target: https://diffpy.github.io/diffpy.structure
         :height: 100px
 
-|PyPi| |Forge| |PythonVersion| |PR|
+|PyPI| |Forge| |PythonVersion| |PR|
 
 |CI| |Codecov| |Black| |Tracking|
 
@@ -26,7 +26,7 @@
 
 .. |PR| image:: https://img.shields.io/badge/PR-Welcome-29ab47ff
 
-.. |PyPi| image:: https://img.shields.io/pypi/v/diffpy.structure
+.. |PyPI| image:: https://img.shields.io/pypi/v/diffpy.structure
         :target: https://pypi.org/project/diffpy.structure/
 
 .. |PythonVersion| image:: https://img.shields.io/pypi/pyversions/diffpy.structure
@@ -132,7 +132,7 @@ trying to commit again.
 
 Improvements and fixes are always appreciated.
 
-Before contribuing, please read our `Code of Conduct <https://github.com/diffpy/diffpy.structure/blob/main/CODE-OF-CONDUCT.rst>`_.
+Before contributing, please read our `Code of Conduct <https://github.com/diffpy/diffpy.structure/blob/main/CODE-OF-CONDUCT.rst>`_.
 
 Acknowledgement
 ---------------
@@ -143,6 +143,8 @@ originate from the `pymmlib project <http://pymmlib.sourceforge.net>`_.
 Less common settings of space groups were generating using the
 `Computational Crystallography Toolbox <http://cctbx.sourceforge.net>`_.
 
+``diffpy.structure`` is built and maintained with `scikit-package <https://scikit-package.github.io/scikit-package/>`_.
+
 Contact
 -------