From 067b24b87c907ac8857032ff6502c5cfa84815d7 Mon Sep 17 00:00:00 2001 From: Nick Dyer Date: Sat, 29 May 2021 22:38:34 -0400 Subject: [PATCH] updated README.md, changed version to "dev_0.0.1" --- README.md | 21 ++++++++++++++++++++- pocket_friends/__init__.py | 2 +- 2 files changed, 21 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8f969e4..106cfb2 100644 --- a/README.md +++ b/README.md @@ -6,4 +6,23 @@ Pocket Friends is a game where you raise your own little pocket friend! These pocket friends, called bloops, are great little companions to have! You can feed them, play with them, and watch them grow up! ~~You can download the latest release of Pocket Friends on the [releases page.](https://github.com/nickedyer/pocket-friends/releases)~~ -There are currently no releases of the game. +There are currently no releases of the game. To install the current version on GitHub, follow the instructions below. + +--- + +## Installing From Source + +Since this game is made in Python, it is fairly easy to set up and install as long as you have Python installed. +Ensure you also have pip installed, as it is required to install Pocket Friends as well. + +### You must have Python 3.6 or greater to install Pocket Friends. + +Once you have Python installed, getting Pocket Friends installed is easy; just install it using pip and you're ready to go! + +`pip install git+https://github.com/nickedyer/pocket-friends.git` + +Now that the game is installed, just run it like you would any other Python program. + +`python -m pocket_friends` + +...and that's it! You now have the latest dev build of Pocket Friends installed on your system! \ No newline at end of file diff --git a/pocket_friends/__init__.py b/pocket_friends/__init__.py index b8023d8..f0ccdbb 100644 --- a/pocket_friends/__init__.py +++ b/pocket_friends/__init__.py @@ -1 +1 @@ -__version__ = '0.0.1' +__version__ = 'dev_0.0.1'