Update readme, minor fix

sowwic · Mar 22, 2021 · 5d99bea · 5d99bea
1 parent a2ed819
commit 5d99bea
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,28 @@
 # dsPlayblast
- Playblast to mp4
+ Playblast to mp4 using FFMPEG 
 
+![ui_dialog](docs/dialog.png)
+
+## Installation
+---
+- Clone repository
+- If folder **qt_widgets_lib** is empty - cd your_cloned_path and run:
+    ```
+    git submodule init && git submodule update
+    ```
+- Add file **ds_playblast.mod** to **Documents/maya/modules** directory with following data:
+  ```
+  + ds_playblast 1.0.1 your_cloned_path/ds_playblast
+  scripts: your_cloned_path/ds_playblast
+  ```
+## Usage
+---
+In Maya run the following Python command:
+```python
+import ds_playblast
+ds_playblast.MainDialog.display()
+```
+
+## Notes
+---
+- Tool will use default FFMPEG executable that comes with it, although it can be overriden in **ds_playblast/config/user.json**
diff --git a/docs/dialog.png b/docs/dialog.png
diff --git a/ds_playblast/main_dialog.py b/ds_playblast/main_dialog.py
@@ -42,7 +42,7 @@ def __init__(self):
         super(MainDialog, self).__init__()
         self.sizes_buffer = []
 
-        self.__class__.UI_INSTANC = self
+        self.__class__.UI_INSTANCE = self
         self.setObjectName(self.__class__.UI_NAME)
         self.setWindowTitle(self.WINDOW_TITLE)
         self.setMinimumSize(300, 165)