From 8872b379df23077f7d8550bcf1aae5d2d1aeb7da Mon Sep 17 00:00:00 2001 From: prafful Date: Mon, 15 Jul 2024 00:16:30 +0530 Subject: [PATCH 1/2] updated readme for improved installation --- README.md | 60 +++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 47 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index e4b7973..1b221db 100644 --- a/README.md +++ b/README.md @@ -37,27 +37,61 @@ The only original thing being done is the editing and gathering of all materials ## Installation 👩‍💻 -1. Clone this repository -2. Run `pip install -r requirements.txt` -3. Run `python -m playwright install` and `python -m playwright install-deps` +1. Clone this repository: + ```sh + git clone https://github.com/elebumm/RedditVideoMakerBot.git + cd RedditVideoMakerBot + ``` + +2. Create and activate a virtual environment: + - On **Windows**: + ```sh + python -m venv venv + venv\Scripts\activate + ``` + - On **macOS and Linux**: + ```sh + python3 -m venv venv + source venv/bin/activate + ``` + +3. Install the required dependencies: + ```sh + pip install -r requirements.txt + ``` + +4. Install Playwright and its dependencies: + ```sh + python -m playwright install + python -m playwright install-deps + ``` + +--- **EXPERIMENTAL!!!!** -On macOS and Linux (debian, arch, fedora and centos, and based on those), you can run an install script that will automatically install steps 1 to 3. (requires bash) + - On macOS and Linux (Debian, Arch, Fedora, CentOS, and based on those), you can run an installation script that will automatically install steps 1 to 3. (requires bash) + - `bash <(curl -sL https://raw.githubusercontent.com/elebumm/RedditVideoMakerBot/master/install.sh)` + - This can also be used to update the installation -`bash <(curl -sL https://raw.githubusercontent.com/elebumm/RedditVideoMakerBot/master/install.sh)` +--- -This can also be used to update the installation +5. Run the bot: + ```sh + python main.py + ``` -4. Run `python main.py` -5. Visit [the Reddit Apps page.](https://www.reddit.com/prefs/apps), and set up an app that is a "script". Paste any URL in redirect URL. Ex:`https://jasoncameron.dev` -6. The bot will ask you to fill in your details to connect to the Reddit API, and configure the bot to your liking -7. Enjoy 😎 -8. If you need to reconfigure the bot, simply open the `config.toml` file and delete the lines that need to be changed. On the next run of the bot, it will help you reconfigure those options. +6. Visit [the Reddit Apps page](https://www.reddit.com/prefs/apps), and set up an app that is a "script". Paste any URL in the redirect URL field, for example: `https://jasoncameron.dev`. -(Note if you got an error installing or running the bot try first rerunning the command with a three after the name e.g. python3 or pip3) +7. The bot will prompt you to fill in your details to connect to the Reddit API and configure the bot to your liking. -If you want to read more detailed guide about the bot, please refer to the [documentation](https://reddit-video-maker-bot.netlify.app/) +8. Enjoy 😎 + +9. If you need to reconfigure the bot, simply open the `config.toml` file and delete the lines that need to be changed. On the next run of the bot, it will help you reconfigure those options. + +(Note: If you encounter any errors installing or running the bot, try using `python3` or `pip3` instead of `python` or `pip`.) + +For a more detailed guide about the bot, please refer to the [documentation](https://reddit-video-maker-bot.netlify.app/). ## Video From aecb7644bef71d6d0c536a1ac6ec5194ebb764f6 Mon Sep 17 00:00:00 2001 From: prafful Date: Mon, 15 Jul 2024 00:50:59 +0530 Subject: [PATCH 2/2] updated to ./venv --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1b221db..8825639 100644 --- a/README.md +++ b/README.md @@ -46,13 +46,13 @@ The only original thing being done is the editing and gathering of all materials 2. Create and activate a virtual environment: - On **Windows**: ```sh - python -m venv venv - venv\Scripts\activate + python -m venv ./venv + .\venv\Scripts\activate ``` - On **macOS and Linux**: ```sh - python3 -m venv venv - source venv/bin/activate + python3 -m venv ./venv + source ./venv/bin/activate ``` 3. Install the required dependencies: