From f60feb57c61b855aa76ffac40320ad3793ac07d6 Mon Sep 17 00:00:00 2001 From: kennydd0 <76538784+kennydd0@users.noreply.github.com> Date: Tue, 1 Jul 2025 12:22:14 +0200 Subject: [PATCH] docs: add beginner install guide --- NOOB_INSTALL_GUIDE.md | 61 +++++++++++++++++++++++++++++++++++++++++++ README.md | 4 +++ 2 files changed, 65 insertions(+) create mode 100644 NOOB_INSTALL_GUIDE.md diff --git a/NOOB_INSTALL_GUIDE.md b/NOOB_INSTALL_GUIDE.md new file mode 100644 index 0000000..f2b0a54 --- /dev/null +++ b/NOOB_INSTALL_GUIDE.md @@ -0,0 +1,61 @@ +# Beginner Friendly Installation Guide + +This guide walks you through installing **Reddit Video Maker Bot** on your computer. It assumes you have little to no experience with the command line. + +## 1. Install Python 3.10 + +1. Visit [python.org](https://www.python.org/downloads/release/python-3100/) and download Python 3.10 for your operating system. +2. Run the installer and make sure the option to **Add Python to PATH** is selected. + +## 2. Install Git + +If you don't already have Git: + +- Windows: download it from [git-scm.com](https://git-scm.com/download/win) and run the installer. +- macOS: install [Homebrew](https://brew.sh) then run `brew install git` in the Terminal. +- Linux: install Git from your package manager, e.g. on Ubuntu run `sudo apt install git`. + +## 3. Download the Bot + +Open your terminal (Command Prompt on Windows) and run: + +```bash +git clone https://github.com/elebumm/RedditVideoMakerBot.git +cd RedditVideoMakerBot +``` + +This downloads the project and moves you into its folder. + +## 4. Install the Python Packages + +Run the following commands inside the `RedditVideoMakerBot` folder: + +```bash +pip install -r requirements.txt +python -m playwright install +python -m playwright install-deps # skip this on Windows +``` + +If the `pip` command fails, try `pip3` instead. On Windows you may need to use `python` instead of `python3`. + +## 5. Run the Bot + +Start the program with: + +```bash +python main.py +``` + +On the first run you'll be asked for some details to connect with Reddit. Follow the prompts. If you ever need to reconfigure, delete the relevant lines from `config.toml` and run the command again. + +## 6. Updating Later + +To update your installation, pull the latest code and reinstall dependencies: + +```bash +git pull +pip install -r requirements.txt +python -m playwright install +``` + +You're now ready to create Reddit videos! If you hit problems, check the [README.md](README.md) or the project's Discord server for help. diff --git a/README.md b/README.md index d39a114..6eb63e8 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,10 @@ The only original thing being done is the editing and gathering of all materials ## Installation 👩‍💻 +If you are brand new to using the command line, check out our +[Beginner Friendly Installation Guide](NOOB_INSTALL_GUIDE.md) for a detailed +walk‑through. + 1. Clone this repository 2. Run `pip install -r requirements.txt` 3. Run `python -m playwright install` and `python -m playwright install-deps`