Skip to content

Latest commit

 

History

History

getting-started

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
execution.md
execution.md
 
 
first-time-start-up.md
first-time-start-up.md
 
 
installation.md
installation.md
 
 

README.md

Getting Started

Setting up the TUI is relatively simple with the provided run scripts. There just may be a few things you need to install beforehand:

Requirements

The only base requirement for the TUI:

  • Git - Allows you to clone the repository

The rest of the requirements are automatically installed through the run script. Here is a list if you would prefer to install them manually:

  • Universal
    • Python >= 3.10
    • pip - Python package manager
    • venv - Python virtual environment manager
  • Linux
    • libudev (CLI requirement)
    • libusb 1.0 (CLI requirement)
  • MacOS
    • Homebrew - Package manager (only used to auto install python)
  • Windows
    • Chocolatey - Package manager (only used to auto install python)

Once you've installed the necessary requirements, you can move on to installing/executing the TUI