Update README.md with installation instructions and usage details

mecasual19 · Apr 14, 2024 · 22f6cca · 22f6cca
1 parent 3ef6f3d
commit 22f6cca
Show file tree

Hide file tree

Showing 2 changed files with 88 additions and 74 deletions.
diff --git a/Local.md b/Local.md
@@ -0,0 +1,83 @@
+# MoneyPrinter - Running locally
+
+Automate the creation of YouTube Shorts locally, simply by providing a video topic to talk about.
+
+> **Important** Please make sure you look through existing/closed issues before opening your own. If it's just a question, please join our [discord](https://dsc.gg/fuji-community) and ask there.
+
+> **🎥** Watch the video on [YouTube](https://youtu.be/mkZsaDA2JnA?si=pNne3MnluRVkWQbE).
+
+## Installation 📥
+
+`MoneyPrinter` requires Python 3.11 to run effectively. If you don't have Python installed, you can download it from [here](https://www.python.org/downloads/).
+
+After you finished installing Python, you can install `MoneyPrinter` by following the steps below:
+
+```bash
+git clone https://github.com/FujiwaraChoki/MoneyPrinter.git
+cd MoneyPrinter
+
+# Install requirements
+pip install -r requirements.txt
+
+# Copy .env.example and fill out values
+cp .env.example .env
+
+# Run the backend server
+cd Backend
+python main.py
+
+# Run the frontend server
+cd ../Frontend
+python -m http.server 3000
+```
+
+See [`.env.example`](.env.example) for the required environment variables.
+
+If you need help, open [EnvironmentVariables.md](EnvironmentVariables.md) for more information.
+
+## Usage 🛠️
+
+1. Copy the `.env.example` file to `.env` and fill in the required values
+1. Open `http://localhost:3000` in your browser
+1. Enter a topic to talk about
+1. Click on the "Generate" button
+1. Wait for the video to be generated
+1. The video's location is `MoneyPrinter/output.mp4`
+
+## Music 🎵
+
+To use your own music, compress all your MP3 Files into a ZIP file and upload it somewhere. Provide the link to the ZIP file in the Frontend.
+
+It is recommended to use Services such as [Filebin](https://filebin.net) to upload your ZIP file. If you decide to use Filebin, provide the Frontend with the absolute path to the ZIP file by using More -> Download File, e.g. (use this [Popular TT songs ZIP](https://filebin.net/klylrens0uk2pnrg/drive-download-20240209T180019Z-001.zip), not this [Popular TT songs](https://filebin.net/2avx134kdibc4c3q))
+
+You can also just move your MP3 files into the `Songs` folder.
+
+## Fonts 🅰
+
+Add your fonts to the `fonts/` folder, and load them by specifying the font name on line `124` in `Backend/video.py`.
+
+## Automatic YouTube Uploading 🎥
+
+MoneyPrinter now includes functionality to automatically upload generated videos to YouTube.
+
+To use this feature, you need to:
+
+1. Create a project inside your Google Cloud Platform -> [GCP](https://console.cloud.google.com/).
+1. Obtain `client_secret.json` from the project and add it to the Backend/ directory.
+1. Enable the YouTube v3 API in your project -> [GCP-API-Library](https://console.cloud.google.com/apis/library/youtube.googleapis.com)
+1. Create an `OAuth consent screen` and add yourself (the account of your YouTube channel) to the testers.
+1. Enable the following scopes in the `OAuth consent screen` for your project:
+
+```
+'https://www.googleapis.com/auth/youtube'
+'https://www.googleapis.com/auth/youtube.upload'
+'https://www.googleapis.com/auth/youtubepartner'
+```
+
+After this, you can generate the videos and you will be prompted to authenticate yourself.
+
+The authentication process creates and stores a `main.py-oauth2.json` file inside the Backend/ directory. Keep this file to maintain authentication, or delete it to re-authenticate (for example, with a different account).
+
+Videos are uploaded as private by default. For a completely automated workflow, change the privacyStatus in main.py to your desired setting ("public", "private", or "unlisted").
+
+For videos that have been locked as private due to upload via an unverified API service, you will not be able to appeal. You’ll need to re-upload the video via a verified API service or via the YouTube app/site. The unverified API service can also apply for an API audit. So make sure to verify your API, see [OAuth App Verification Help Center](https://support.google.com/cloud/answer/13463073) for more information.
diff --git a/README.md b/README.md
@@ -1,86 +1,17 @@
 # MoneyPrinter 💸
 
-Automate the creation of YouTube Shorts locally, simply by providing a video topic to talk about.
+Automate the creation of YouTube Shorts, simply by providing a video topic to talk about.
 
 > **Important** Please make sure you look through existing/closed issues before opening your own. If it's just a question, please join our [discord](https://dsc.gg/fuji-community) and ask there.
 
 > **🎥** Watch the video on [YouTube](https://youtu.be/mkZsaDA2JnA?si=pNne3MnluRVkWQbE).
 
-## Installation 📥
+There are two ways to use `MoneyPrinter`, either:
 
-`MoneyPrinter` requires Python 3.11 to run effectively. If you don't have Python installed, you can download it from [here](https://www.python.org/downloads/).
+- the [hosted, no-code version](https://rhea.azen.app) (rebranded as `Rhea`), or
+- the [local version](Local.md).
 
-After you finished installing Python, you can install `MoneyPrinter` by following the steps below:
-
-```bash
-git clone https://github.com/FujiwaraChoki/MoneyPrinter.git
-cd MoneyPrinter
-
-# Install requirements
-pip install -r requirements.txt
-
-# Copy .env.example and fill out values
-cp .env.example .env
-
-# Run the backend server
-cd Backend
-python main.py
-
-# Run the frontend server
-cd ../Frontend
-python -m http.server 3000
-```
-
-See [`.env.example`](.env.example) for the required environment variables.
-
-If you need help, open [EnvironmentVariables.md](EnvironmentVariables.md) for more information.
-
-## Usage 🛠️
-
-1. Copy the `.env.example` file to `.env` and fill in the required values
-1. Open `http://localhost:3000` in your browser
-1. Enter a topic to talk about
-1. Click on the "Generate" button
-1. Wait for the video to be generated
-1. The video's location is `MoneyPrinter/output.mp4`
-
-## Music 🎵
-
-To use your own music, compress all your MP3 Files into a ZIP file and upload it somewhere. Provide the link to the ZIP file in the Frontend.
-
-It is recommended to use Services such as [Filebin](https://filebin.net) to upload your ZIP file. If you decide to use Filebin, provide the Frontend with the absolute path to the ZIP file by using More -> Download File, e.g. (use this [Popular TT songs ZIP](https://filebin.net/klylrens0uk2pnrg/drive-download-20240209T180019Z-001.zip), not this [Popular TT songs](https://filebin.net/2avx134kdibc4c3q))
-
-You can also just move your MP3 files into the `Songs` folder. 
-
-## Fonts 🅰
-
-Add your fonts to the `fonts/` folder, and load them by specifying the font name on line `124` in `Backend/video.py`.
-
-## Automatic YouTube Uploading 🎥
-
-MoneyPrinter now includes functionality to automatically upload generated videos to YouTube.
-
-To use this feature, you need to:
-
-1. Create a project inside your Google Cloud Platform -> [GCP](https://console.cloud.google.com/).
-1. Obtain `client_secret.json` from the project and add it to the Backend/ directory.
-1. Enable the YouTube v3 API in your project -> [GCP-API-Library](https://console.cloud.google.com/apis/library/youtube.googleapis.com)
-1. Create an `OAuth consent screen` and add yourself (the account of your YouTube channel) to the testers.
-1. Enable the following scopes in the `OAuth consent screen` for your project:
-
-```
-'https://www.googleapis.com/auth/youtube'
-'https://www.googleapis.com/auth/youtube.upload'
-'https://www.googleapis.com/auth/youtubepartner'
-```
-
-After this, you can generate the videos and you will be prompted to authenticate yourself.
-
-The authentication process creates and stores a `main.py-oauth2.json` file inside the Backend/ directory. Keep this file to maintain authentication, or delete it to re-authenticate (for example, with a different account).
-
-Videos are uploaded as private by default. For a completely automated workflow, change the privacyStatus in main.py to your desired setting ("public", "private", or "unlisted").
-
-For videos that have been locked as private due to upload via an unverified API service, you will not be able to appeal. You’ll need to re-upload the video via a verified API service or via the YouTube app/site. The unverified API service can also apply for an API audit. So make sure to verify your API, see [OAuth App Verification Help Center](https://support.google.com/cloud/answer/13463073) for more information.
+Check out the instructions for the local version [here](Local.md). If you want to use the hosted version, please visit [Rhea](https://rhea.azen.app).
 
 ## FAQ 🤔