Update README Installation Steps

bpas247 commented 6 years ago

Currently, the README installation steps were confusing and did not work for me when I followed them. The issue I ran into is that the package needed to be installed locally first before running the CLI application. I was told to run the .testingScript.sh script, but that didn't work either (since it was trying to invoke python3 and I had no associated system environment variable). What ended up working is running the following command: python ./setup.py develop. The README should be updated in the following way:

[ ] Add a step to run the testing script in order to properly install it.
[ ] Document alternative steps in the installation process (in case the primary steps don't work).

Chris-Johnston commented 6 years ago

What operating system are you using?

What is the output of python --version (or python3 --version)?

And yeah, I agree that the local installation using setup.py needs to be documented better.

Chris-Johnston commented 6 years ago

This is sorta explained in the contributing file here: https://github.com/Chris-Johnston/Easier68k/blob/master/.github/CONTRIBUTING.md#running-tests

bpas247 commented 6 years ago

OS: Microsoft Windows [Version 10.0.16299.431] Python Version: 3.6.5

Chris-Johnston / Easier68k

Update README Installation Steps #106