Added Installation Troubleshooting to README

INeido · Oct 30, 2023 · fdbcda5 · fdbcda5
1 parent d63044d
commit fdbcda5
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -32,8 +32,35 @@ git clone https://github.com/INeido/CGOL
 pip install -e CGOL/.
 ```
 
+### Troubleshooting Installation
+
+If you encounter any errors during the installation process, consider the following options:
+
+If pip is not found you can try to access it using 
+```bash
+python -m pip
+```
+or install it using
+```bash
+python -m ensurepip
+```
+
+You can attempt to install using pipx, a tool designed for running Python applications in isolated environments
+```bash
+pipx install cgol
+```
+
+If issues persist, create a virtual environment and install within it for a clean and isolated setup
+```bash
+python -m venv .venv
+source .venv/bin/activate
+pip install cgol
+```
+
 ## Usage
 
+NOTE: If you installed using pipx you might have to run `pipx ensurepath` once or prepend `pipx run` to the example commands below.
+
 Here are some examples.
 
 Start a simulation with the default setting but with a custom seed.

diff --git a/pyproject.toml b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "CGOL"
-version = "0.9.5"
+version = "0.9.6"
 description = "A whack Conway's Game of Life implementation."
 readme = "README.md"
 requires-python = ">=3"

diff --git a/requirements.txt b/requirements.txt
@@ -1,3 +1,4 @@
 argparse
 pygame
 numpy
+setuptools