diff --git a/README.md b/README.md new file mode 100644 index 0000000..e507a80 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# 🎬 Zordon - Render Management Tools 🎬 + +Welcome to Zordon! This is a hobby project written with fellow filmmakers in mind. It's a local network render farm manager, aiming to streamline and simplify the rendering process across multiple home computers. + +## 📦 Installation + +Make sure to install the necessary dependencies: `pip3 install -r requirements.txt` + +## 🚀 How to Use + +Zordon has two main files: `start_server.py` and `start_client.py`. + +- **start_server.py**: Run this on any computer you want to render jobs. It manages the incoming job queue and kicks off the appropriate render jobs when ready. +- **start_client.py**: Run this to administer your render servers. It lets you manage and submit jobs. + +When the server is running, the job queue can be accessed via a web browser on the server's hostname (default port is 8080). You can also access it via the GUI client or a simple view-only dashboard. + +## 🎨 Supported Renderers + +Zordon currently supports the following renderers: + +- **Blender** +- **FFMPEG**