jacobhillock / rubikstimer

Python based rubik's cube timer with ability to allow user data analysis

Rubik's Timing

Ethos

This software is being created because I am a studying data science student and I want more ways to analyze my solve. This is being written to be dynamic with a config file.

Requirements

• Python 3.8 + (I used python 3.8 but older versions may work)

Installation

1. Install Python3.8+

2. Download Code

   • Click 'Clone or download'
   • Click 'Download ZIP
   • Go to download location and extract

3. Create Virtual Environment

   • Windows:
   • Press SHIFT and RIGHT CLICK in folder
   • LEFT CLICK 'Open PowerShell window here'
   • run:

   py -m venv venv
   

   • Linux/IOS:
   • In terminal:

   cd LOCATION OF CODE
   python -m venv venv
   

4. Activate Virtual Environment

   • Windows: run venv\Scripts\activate.bat
   • Linux/IOS: run source venv/bin/activate

5. Install required modules

pip install -r requirements.txt

6. Run Application
   • Windows: double click launch.bat
   • Linux/IOS: run 'bash launch.sh'