Skip to content

Commit 1b3a34a

Browse files
Updates installation instructions in README.md and install.rst
- Clarified that Decomp can be installed from PyPI, including specific commands for optional features. - Added code blocks for installation commands to improve readability and user experience. - Ensured consistency in installation instructions across documentation files.
1 parent 8f5f086 commit 1b3a34a

File tree

2 files changed

+22
-2
lines changed

2 files changed

+22
-2
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Overview
22

3+
[![PyPI version](https://badge.fury.io/py/decomp.svg)](https://badge.fury.io/py/decomp)
34
[![GitHub](https://img.shields.io/badge/github-decomp-blue?logo=github)](https://github.com/decompositional-semantics-initiative/decomp)
45
[![CI](https://github.com/decompositional-semantics-initiative/decomp/actions/workflows/ci.yml/badge.svg)](https://github.com/decompositional-semantics-initiative/decomp/actions/workflows/ci.yml)
56
[![Documentation](https://readthedocs.org/projects/decomp/badge/?version=latest)](https://decomp.readthedocs.io/en/latest/?badge=latest)
@@ -103,7 +104,13 @@ docker run -it decomp python
103104
```
104105

105106
If you prefer to install directly to your local environment, you can
106-
use `pip` to install from GitHub:
107+
use `pip` to install from PyPI:
108+
109+
```bash
110+
pip install decomp
111+
```
112+
113+
Or install the latest development version from GitHub:
107114

108115
```bash
109116
pip install git+https://github.com/decompositional-semantics-initiative/decomp.git

docs/source/install.rst

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,20 @@ Installation
3131
3232
.. tab-item:: pip
3333

34-
Decomp can be installed from GitHub using ``pip``:
34+
Decomp can be installed from PyPI using ``pip``:
35+
36+
.. code-block:: bash
37+
38+
pip install decomp
39+
40+
To install optional features:
41+
42+
.. code-block:: bash
43+
44+
pip install decomp[viz] # For visualization features
45+
pip install decomp[parsing] # For parsing features (future)
46+
47+
Or install the latest development version from GitHub:
3548

3649
.. code-block:: bash
3750

0 commit comments

Comments
 (0)