Skip to content
This repository has been archived by the owner on Jun 22, 2023. It is now read-only.

Commit

Permalink
Fix docs and project metadata :p
Browse files Browse the repository at this point in the history
  • Loading branch information
ichard26 committed Aug 14, 2021
1 parent 99a0f35 commit ed84648
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 14 deletions.
2 changes: 1 addition & 1 deletion docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Date of release: *n/a*

**Bugfixes & enhancements**:

- *so far it's looking like a desert*
- Fixed broken (whoops!) documentation link in project metadata.

## 21.8a1

Expand Down
16 changes: 4 additions & 12 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,20 @@

## Installation

```{note}
Currently blackbench isn't available on PyPI. Although publishing to PyPI is planned
once blackbench reaches a state where it's generally usable. For now, you have two
main choices for installing blackbench.
```

**Prerequisite:** Python 3.8 or higher[^1]

The first one is going to the releases page from this project's GitHub homepage and
downloading the wheel for the version you'd like. Then once available locally, you can
pass that file to pip:
Blackbench is available through PyPI so it's pretty easy to install.

```bash
pip install path/to/the/downloaded/wheel.whl
python -m pip install blackbench
```

The other one is installing via a VSC URL with pip. This will pull down the newest
Your other option is installing via a VSC URL with pip. This will pull down the newest
revision of blackbench (in other words, whatever is in `main`). Unreleased versions of
blackbench should work just fine, but may have bugs and other half-implemented features.

```bash
pip install git+git://github.com/ichard26/blackbench
python -m pip install git+git://github.com/ichard26/blackbench
```

`````{tip}
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ requires-python = ">=3.8"
blackbench = "blackbench:main"

[tool.flit.metadata.urls]
Documentation = "https://blackbench.readthedocs.io/en/stable"
Documentation = "https://blackbench.readthedocs.io/en/stable/"
Changelog = "https://blackbench.readthedocs.io/en/latest/changelog.html"

[tool.black]
Expand Down

0 comments on commit ed84648

Please sign in to comment.