Skip to content

Docs #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nhew1994 merged 3 commits into from
Mar 3, 2026
Merged

Docs #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
12b3c16
Update PyPI installation section in README
nhew1994 Mar 3, 2026
5fd0cad
Revise PyPI installation note in installation.md
nhew1994 Mar 3, 2026
44a692a
Update installation instructions in README
nhew1994 Mar 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,10 @@ Using Conda:
conda activate pyzentropy

## Install pyzentropy
### From PyPI (coming soon)
### From PyPI

python -m pip install pyzentropy
Comment on lines +13 to 15
Copy link

Copilot AI Mar 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This heading was changed to “From PyPI”, but later in the same README section there is still a note saying PyPI installation will be available in a future release. Please either remove/update that note (if PyPI is now published) or keep the heading as “(coming soon)” to avoid contradicting the instructions.

Copilot uses AI. Check for mistakes.

<sub>PyPI installation will be available in a future release. For now, please install from source as described below.</sub>

### From Source

Clone the repository:
Expand Down
5 changes: 1 addition & 4 deletions docs/_source/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,10 @@ Using Conda:

<span style="font-size:1.3em; font-weight:bold">Install pyzentropy</span>

<span style="font-size:1.1em; font-weight:bold">From PyPI (coming soon)</span>
<span style="font-size:1.1em; font-weight:bold">From PyPI</span>

python -m pip install pyzentropy

**Note:** PyPI installation will be available in a future release. For now, please install from source as described below.


<span style="font-size:1.1em; font-weight:bold">From Source</span>

Clone the repository:
Expand Down