From cbbedf7cc8173751f6fab306cd37578c159f53e2 Mon Sep 17 00:00:00 2001 From: Eric Fell Date: Sun, 21 Sep 2025 17:35:29 -0400 Subject: [PATCH] add license indicators for toml, pip instructions --- README.md | 4 ++-- docs/source/index.rst | 6 +++++- pyproject.toml | 5 ++++- 3 files changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1e85386..fc02e69 100644 --- a/README.md +++ b/README.md @@ -14,10 +14,10 @@ Currently available mechanisms: ## Installation -`cvsim` can be installed from GitHub: +`cvsim` can be installed from PyPI using pip: ```bash -git clone git@github.com:ericfell/CVsim.git +pip install cvsim ``` See [Getting started with `cvsim.py`](https://cvsim.readthedocs.io/en/latest/getting-started.html) for instructions on simulating CVs. diff --git a/docs/source/index.rst b/docs/source/index.rst index 074674c..1c4b741 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -21,7 +21,11 @@ or contribute code improvements and Installation ------------ -:code:`cvsim.py` can be installed .... +:code:`cvsim.py` can be installed from PyPI with pip: + +.. code-block:: bash + + pip install cvsim Dependencies diff --git a/pyproject.toml b/pyproject.toml index 9c32128..6c5ccfb 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -16,10 +16,13 @@ requires-python = ">=3.10" dependencies = ["scipy"] classifiers = [ "Programming Language :: Python :: 3", - "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", ] keywords = ["electrochemistry", "cyclic voltammetry"] +license = "MIT" +license-files = [ + "LICENSE", +] [project.urls] Homepage = "https://github.com/ericfell/CVsim"