Merge pull request #15 from ycexiao/update-readme

docs: update `README`

Author: sbillinge

README.rst

@@ -36,9 +36,10 @@
 .. |Tracking| image:: https://img.shields.io/badge/issue_tracking-github-blue
         :target: https://github.com/diffpy/diffpy.apps/issues
 
-User applications to help with tasks using diffpy packages
+User applications to help with tasks using diffpy packages. Currently it
+contains
 
-* LONGER DESCRIPTION HERE
+- `runmacro`: A runner for DiffPy macro files.
 
 For more information about the diffpy.apps library, please consult our `online documentation <https://diffpy.github.io/diffpy.apps>`_.
 
@@ -63,7 +64,7 @@ To add "conda-forge" to the conda channels, run the following in a terminal. ::
 We want to install our packages in a suitable conda environment.
 The following creates and activates a new environment named ``diffpy.apps_env`` ::
 
-        conda create -n diffpy.apps_env diffpy.apps
+        conda create -n diffpy.apps_env diffpy.apps python=3.13
         conda activate diffpy.apps_env
 
 The output should print the latest version displayed on the badges above.

news/update-readme.rst

@@ -0,0 +1,24 @@
+**Added:**
+
+* Also add ``diffpy.apps`` as an entry point.
+* Add ``runmacro`` in the ``README``.
+
+**Changed:**
+
+* Use ``python=3.13`` as default before ``python=3.14`` is supported by ``diffpy.cmi``.
+
+**Deprecated:**
+
+* <news item>
+
+**Removed:**
+
+* <news item>
+
+**Fixed:**
+
+* <news item>
+
+**Security:**
+
+* <news item>

pyproject.toml

@@ -51,6 +51,7 @@ exclude = []  # exclude packages matching these glob patterns (empty by default)
 namespaces = false  # to disable scanning PEP 420 namespaces (true by default)
 
 [project.scripts]
+"diffpy.apps" = "diffpy.apps.apps:main"
 "diffpy.app" = "diffpy.apps.apps:main"
 
 [tool.setuptools.dynamic]

src/diffpy/apps/apps.py

@@ -29,8 +29,8 @@ def main():
 
     parser.add_argument(
         "--version",
-        action="store_true",
-        help="Show the program's version number and exit",
+        action="version",
+        version=f"diffpy.apps {__version__}",
     )
     apps_parsers = parser.add_subparsers(
         title="Available applications",