pyGoL

Python Game of Life.

Table of Contents

• Getting Started
  • Prerequisites
  • Initial setup
• Running
  • Installing
  • Launching
• Distributing
  • Installing additional packages
• Contributing
• Versioning
• Authors
• License
• Acknowledgments

Getting Started

These instructions will get you a copy of the project up and running on your local machine.

Prerequisites

You will need python3 and pip3 installed on your machine. You can install it from the official website https://www.python.org/.

Initial setup

A step by step series of examples that tell you how to get a virtual python environment running:

Clone the git repository

git clone https://github.com/umcconnell/pygol.git

And navigate into the folder

cd pygol/

Then create your virtual environment

python3 -m venv venv

Finally, start the virtual environment

source venv/bin/activate

To exit the virtual environment run

deactivate

Happy coding!

Running

Installing

To get started, activate the virtual environment:

source venv/bin/activate

Install the packages from requirements.txt:

python3 -m pip install -r requirements.txt

Launching

Launch a simple pygame window running a random life simulation:

python3 main.py pygame

See the available CLI options, such as specifying RLE files:

python3 main.py -h

Distributing

Installing additional packages

After activating the virtual environment, install your package(s)

python -m pip install <package>

Then freeze your packages

python -m pip freeze > requirements.txt

Contributing

Please read CONTRIBUTING.md and CODE_OF_CONDUCT.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

Ulysse McConnell - umcconnell

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Acknowledgments

• LifeWiki - Information on Conway's Game of Life
• numpy gitignore - Gitignore inspiration
• github python gitignore template - The gitignore template
• python3 tutorial - Guide and explanations
• VirtualEnv - Guide and explanations
• python-virtual-environment-howto - Guide and explanations