Skip to content

Commit

Permalink
Added Installation Troubleshooting to README
Browse files Browse the repository at this point in the history
  • Loading branch information
INeido committed Oct 30, 2023
1 parent d63044d commit fdbcda5
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 1 deletion.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
argparse
pygame
numpy
setuptools

0 comments on commit fdbcda5

Please sign in to comment.