diff --git a/README.rst b/README.rst index 7fe1bcd..1a2b68d 100644 --- a/README.rst +++ b/README.rst @@ -41,20 +41,19 @@ Currently it provides: 1. Macro interface for PDF refinements. Supported by the command ``runmacro``. 2. Agent interface for PDF refinements. Supported by the included MCP server. -For more information about the diffpy.apps library, please consult our `online documentation `_. +For more information about the ``diffpy.apps`` library, please consult our `online documentation `_. Citation -------- -If you use diffpy.apps in a scientific publication, we would like you to cite this package as +If you use ``diffpy.apps`` in a scientific publication, we would like you to cite this package as diffpy.apps Package, https://github.com/diffpy/diffpy.apps Installation ------------ -The preferred method is to use `Miniconda Python -`_ +The preferred method is to use `Miniconda Python `_ and install from the "conda-forge" channel of Conda packages. To add "conda-forge" to the conda channels, run the following in a terminal. :: @@ -113,7 +112,7 @@ Support and Contribute If you see a bug or want to request a feature, please `report it as an issue `_ and/or `submit a fix as a PR `_. -Feel free to fork the project and contribute. To install diffpy.apps +Feel free to fork the project and contribute. To install ``diffpy.apps`` in a development mode, with its sources being directly used by Python rather than copied to a package directory, use the following in the root directory :: @@ -139,7 +138,7 @@ Before contributing, please read our `Code of Conduct `_ or email the maintainers ``Yuchen Xiao(yx2924@columbia.edu) and Simon Billinge(sbillinge@ucsb.edu)``. +For more information on ``diffpy.apps`` please visit the project `web-page `_ or email the maintainers ``Yuchen Xiao(xiaoyuch@msu.edu) and Simon Billinge(sbillinge@ucsb.edu)``. Acknowledgements ---------------- diff --git a/news/update-readme.rst b/news/update-readme.rst new file mode 100644 index 0000000..7c9d977 --- /dev/null +++ b/news/update-readme.rst @@ -0,0 +1,23 @@ +**Added:** + +* No news added: Update ``README.rst``. + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +*