Skip to content

Commit

Permalink
Clarify that only Linux is supported
Browse files Browse the repository at this point in the history
  • Loading branch information
claui committed Jul 30, 2024
1 parent 2032de2 commit 4fb1226
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 38 deletions.
31 changes: 1 addition & 30 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,35 +10,16 @@ To set up Itchcraft, you need three things:

3. The Python dependency manager `poetry`.

### Installing pyenv
### Installing pyenv on Linux

The Python version manager `pyenv` makes sure you can always keep
the exact Python version required by Itchcraft,
regardless of your system Python.

#### Installing pyenv on Windows

While `pyenv` doesn’t support Windows, you can use a drop-in
replacement called `pyenv-win`.

To install `pyenv-win` on Windows, go to
[github.com/pyenv-win/pyenv-win](https://github.com/pyenv-win/pyenv-win#installation)
and follow one of the installation methods.

#### Installing pyenv on Linux

To install `pyenv` on Linux or WSL2, first make sure Python 3 is
installed. Then follow the *Basic GitHub Checkout* method described
at [github.com/pyenv/pyenv](https://github.com/pyenv/pyenv#basic-github-checkout).

#### Installing pyenv on macOS

To install `pyenv` on macOS, run:

```
brew install pyenv
```

#### Checking your system-wide pyenv installation

To verify your `pyenv` is working, run:
Expand Down Expand Up @@ -70,16 +51,6 @@ Proceed after you’ve confirmed one of those to work.

You’ll need `poetry` to manage development dependencies and the venv.

To install Poetry on Windows, use one of the
[installation methods](https://python-poetry.org/docs/master/#installing-with-the-official-installer)
described in Poetry’s documentation.

To install Poetry on macOS, run:

```
brew install poetry
```

If you’re on Linux or WSL2, use your system package manager to
install Poetry.

Expand Down
10 changes: 2 additions & 8 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,12 @@ warn_unused_ignores = true
name = "itchcraft"
version = "0.2.0"
description = "Tech demo for interfacing with heat-based USB insect bite healers"
readme = [
"README.md",
"USAGE.md",
]
authors = [
"Claudia Pellegrino <[email protected]>",
]
readme = ["README.md", "USAGE.md"]
authors = ["Claudia Pellegrino <[email protected]>"]
license = "Apache-2.0"
# See https://pypi.org/pypi?%3Aaction=list_classifiers
classifiers = [
"Development Status :: 3 - Alpha",
"Operating System :: MacOS",
"Operating System :: POSIX :: Linux",
"Topic :: Utilities",
]
Expand Down

0 comments on commit 4fb1226

Please sign in to comment.