Skip to content

Latest commit

 

History

History
62 lines (38 loc) · 1.41 KB

readme.MD

File metadata and controls

62 lines (38 loc) · 1.41 KB
Raw

Getting Started

Follow these steps to set up the project on your machine:

  1. Clone the repo to the machine you want to run this on.
  2. From the shell in the root project directory, type pip install -r requirements.txt.
  3. From the shell, in the 'project_root/src' directory type:
    • python3 surf_main.py for Linux
    • python surf_main.py for Windows
  4. Use the editor!

Prerequisites

  • Prerequisite libraries are listed in the requirements.txt file.
  • Works with Python version 3.10 and likely most other Python iterations of version 3

Installing

To install the necessary components:

  1. Clone the repo to the machine you want to run this on.
  2. From the shell in the root project directory, type pip install -r requirements.txt.

Usage

To be added later.

Running the Tests

Execute the tests within the tests directory using:

pytest test*

Built With

  1. Pyside 6
  2. Python 3.10
  3. Qt Designer

Contributing

Please contribute!

Authors

License

This project is licensed under the MIT license.

Acknowledgments

This project was made possible by the knowledge from this book:

  • Mastering GUI Programming with Python: Develop Impressive Cross-platform GUI Applications with PyQt by Alan D. Moore, 2019.

Also made possible by this wonderful IDE: