Merge pull request #15 from industArk/develop

Develop

Makefile

@@ -1,2 +1,2 @@
 zip:
-	tar -C .. -acf scripter.zip bl_scripter/__init__.py bl_scripter/src
+	tar -C .. -acf scripter.zip scripter/__init__.py scripter/src

README.md

@@ -1,6 +1,30 @@
 # Scripter
 
-by inDustArk (Data Verft Arkadiusz Choruzy)
+Blender addon for using python PYPI packages.
 
 ---
 
+### Overview
+
+Scripter is simple addon that allows you to install and use python libraries (packages) that are not normally given with Blender. The addon lets you to install packages from PYPI [https://pypi.org/] and adds them automatically at each next Blender start (they are not purged as usuall).
+
+### Installation
+
+Addon installation is simple as always. Just download the release, then in Blender click `Edit -> Preferences`. In `Add-ons` click install and chose the scripter.zip file.
+
+### How to use
+
+All you need to do is to add `PYPI libraries`, click `UPDATE LIBRARIES` and then wait for a while to install them.
+![](.readme/image.png)
+
+NOTE! While installing, Blender is not responsive for some time. It is recommended to open Blender's console window (`Window -> Toggle System Console`) for installation observation. 
+
+### Contribution and testing
+
+Test status: Addon was tested on Blender 3.3 and 3.6. It is known issue it sometimes crashes after installation of new packages (while they are available after reopening Blender)
+
+Please feel free to contribute with addon development.
+
+---
+
+Copyright (C) 2023 Arkadiusz Choruzy aka inDustArk

__init__.py

@@ -1,5 +1,5 @@
 # Scripter
-# Copyright (C) 2023  Data Verft Arkadiusz Choruzy aka inDustArk
+# Copyright (C) 2023 Arkadiusz Choruzy aka inDustArk
 
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -25,9 +25,9 @@
 
 
 bl_info = {
-    "name": "bl_scripter",
+    "name": "Scripter",
     "description": "Tools and utils for scripting blender easier.",
-    "author": "Data Verft Arkadiusz Choruzy",
+    "author": "Arkadiusz Choruzy",
     "version": (2023, 0, 1),
     "blender": (3, 0, 0),
     "location": "Scripting",

src/addon_preferences.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023  Data Verft Arkadiusz Choruzy aka inDustArk
+# Copyright (C) 2023 Arkadiusz Choruzy aka inDustArk
 
 
 import bpy

src/properties.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023  Data Verft Arkadiusz Choruzy aka inDustArk
+# Copyright (C) 2023 Arkadiusz Choruzy aka inDustArk
 
 
 import os

src/properties_ops.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023  Data Verft Arkadiusz Choruzy aka inDustArk
+# Copyright (C) 2023 Arkadiusz Choruzy aka inDustArk
 
 
 import bpy

src/scripter.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023  Data Verft Arkadiusz Choruzy aka inDustArk
+# Copyright (C) 2023 Arkadiusz Choruzy aka inDustArk
 
 
 from pathlib import Path