README.md

README - CLI

Version 1.0 - CLI

#================#

CONTENTS

1. Requirements
2. How to run
3. How to play
4. Final notes

#================#

1. Requirements

The following libraries are required in order to play 'Wumpus'.

Required libraries:

• PrettyTable
• Python 3.5.2

Can be installed via pip.

2. How to run

Navigate to the current folder in a CLI ('Wumpus-CLI') and execute main.py by running :

On Windows:

python main.py

On Linux:

python3 main.py  	(Python 3)

python main.py   	(Python 2)

On OSX:

python main.py

3. How to play

Instructions on how to play are given in-game.

4. Final Notes

If you've run doctest, you may need to reset the highscore.txt in the asset folder.

Doctest may cause some unwanted spaces.