Skip to content

Commit ce60832

Browse files
committed
Updated README, requirements and installation explanations.
- Added the Black badge to the README.md file. - Replaced "requirements.yml" with "environment.yml" in the installation instructions. - Added the sphinx version to the requirements.txt file.
1 parent 8e34c4d commit ce60832

File tree

3 files changed

+5
-3
lines changed

3 files changed

+5
-3
lines changed

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
![ELASPY logo](doc/_static/ELASPY_light.svg)
2+
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
23

34
# ELASPY
45

doc/installation/installation.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ You can easily download all files from the GitHub repository. Follow these steps
1919
2020
cd documents/ELASPY
2121
22-
5. Use an environment manager to create an environment in which you can run the code, such as `Anaconda <https://anaconda.org>`_ or `Miniconda <https://docs.anaconda.com/miniconda/>`_. You can use the following command to create an environment called ``ELASPY`` by using the ``requirements.yml`` file that is also part of your ``ELASPY`` folder:
22+
5. Use an environment manager to create an environment in which you can run the code, such as `Anaconda <https://anaconda.org>`_ or `Miniconda <https://docs.anaconda.com/miniconda/>`_. You can use the following command to create an environment called ``ELASPY`` by using the ``environment.yml`` file that is also part of your ``ELASPY`` folder:
2323

2424
.. code-block:: shell
2525
@@ -51,7 +51,7 @@ Manually
5151
5252
cd documents/ELASPY
5353
54-
5. Use an environment manager to create an environment in which you can run the code, such as `Anaconda <https://anaconda.org>`_ or `Miniconda <https://docs.anaconda.com/miniconda/>`_. You can use the following command to create an environment called ``ELASPY`` by using the ``requirements.yml`` file that can be downloaded from the GitHub repository:
54+
5. Use an environment manager to create an environment in which you can run the code, such as `Anaconda <https://anaconda.org>`_ or `Miniconda <https://docs.anaconda.com/miniconda/>`_. You can use the following command to create an environment called ``ELASPY`` by using the ``environment.yml`` file that can be downloaded from the GitHub repository:
5555

5656
.. code-block:: shell
5757

requirements.txt

+2-1
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,5 @@ pytest==7.3.1
88
pluggy==1.0.0
99
mypy==0.981
1010
pydata-sphinx-theme==0.15.3
11-
sphinx-design==0.6.0
11+
sphinx-design==0.6.0
12+
sphinx==5.0.2

0 commit comments

Comments
 (0)