From 4fb1226895fe5966a91dfed1d5fae6ce84e2e7d4 Mon Sep 17 00:00:00 2001 From: Claudia Pellegrino Date: Tue, 30 Jul 2024 15:35:06 +0200 Subject: [PATCH] Clarify that only Linux is supported --- CONTRIBUTING.md | 31 +------------------------------ pyproject.toml | 10 ++-------- 2 files changed, 3 insertions(+), 38 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0367403..c733fb4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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: @@ -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. diff --git a/pyproject.toml b/pyproject.toml index 15aeee1..b85fb3e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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 ", -] +readme = ["README.md", "USAGE.md"] +authors = ["Claudia Pellegrino "] 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", ]