From e8a4692e0f3ccc5d367214d5448f4b35aedb23a6 Mon Sep 17 00:00:00 2001 From: Brett Date: Thu, 15 Aug 2024 15:10:37 -0500 Subject: [PATCH] Update README.md --- README.md | 37 +++++++++++++++++++++++++++++-------- 1 file changed, 29 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 4c7b1ee..e8e6faa 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,35 @@ -# 🎬 Zordon - Render Management Tools +# Zordon -Welcome to Zordon! It's a local network render farm manager, aiming to streamline and simplify the rendering process across multiple home computers. +A tool designed for small render farms, such as those used in home studios or small businesses, to efficiently manage and run render jobs for Blender, FFMPEG, and other video renderers. It simplifies the process of distributing rendering tasks across multiple available machines, optimizing the rendering workflow for artists, animators, and video professionals. -## 📦 Installation +## Supported Renderers -Install the necessary dependencies: `pip3 install -r requirements.txt` - -## 🎨 Supported Renderers - -Zordon currently supports the following renderers: +Zordon supports or plans to support the following renderers: - **Blender** - **FFMPEG** +- **Adobe After Effects** ([coming soon](https://github.com/blw1138/Zordon/issues/84)) +- **Cinema 4D** ([planned](https://github.com/blw1138/Zordon/issues/105)) +- **Autodesk Maya** ([planned](https://github.com/blw1138/Zordon/issues/106)) + +## System Requirements + +- Windows 10 or later +- macOS Ventura (13.0) or later +- Linux (Supported versions TBD) + +## Build using Pyinstaller + +Zordon is regularly tested with Python 3.11 and later. It's packaged and distributed with pyinstaller. It is supported on Windows, macOS and Linux. + +``` +git clone https://github.com/blw1138/Zordon.git +pip3 install -r requirements.txt +pip3 install pyinstaller +pip3 install pyinstaller_versionfile +pyinstaller main.spec +``` + +## License + +Zordon is licensed under the MIT License. See the [LICENSE](LICENSE.txt) file for more details.