Presentation Karaoke Program

This Python 3 project utilizes Hovercraft to generate a randomized presentation from a list of pre-defined presentations. This tool also leverages PyTorch for additional functionality if needed in future updates.

Installation

1. Clone or download this repository onto your local machine using git clone https://github.com/username/repo.git command.
2. Navigate into the cloned directory via terminal / cmd prompt.
3. Create a virtual environment by running 'python -m venv env'. Activate the environment based on your OS ('source env/bin/activate' for Unix systems, '.\env\Scripts\Activate' for Windows)
4. Use Pipenv to manage dependencies. Run 'pipenv install'. Make sure all required libraries have been included in the Pipfile before proceeding.
5. To start the application, simply type 'hovercraft presenter.py' followed by the name of your slide deck (.rst format), e.g., 'hovercraft my_slides.rst'.
6. If PyTorch needs to be used, ensure its installation was successful by checking whether importing torch in Python returns no errors.
7. For more information about installing specific tools such as Hovercraft, refer to their respective documentation linked below.

Usage

Generating slides

Note: This uses generative LLM AI. ensure pytorch is installed.

$ pipenv run python -m karaoke.slides

Running a random presentation

$ pipenv run python -m karaoke.karaoke

Documentation

For further details regarding how to contribute to this project, please see CONTRIBUTING guide. Further technical specifications including code style guidelines, testing procedures etc. may be found under DOCUMENTATION section.

Contributors

A big thank you goes out to these wonderful people (emoji key):

All Contributors

Made with ❤️ by Your Name