From f375ad6172c3385f6bbc01f4c846370409ed3f5f Mon Sep 17 00:00:00 2001 From: TDV Alinsa Date: Fri, 29 Jan 2021 10:49:10 -0800 Subject: [PATCH] update README.md for initial beta release --- README.md | 30 +++++++++++++++++++++--------- 1 file changed, 21 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 97de40d..197f3f8 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,23 @@ -# Blender Info Text +# Blender Infotext This is a simple module that displays a bunch of information inside -the 3D View window, in a somewhat configurable manner. Most of this -code has been stolen blatantly from the wonderful Speedflow -(), whose features -I've found I don't really need... but I wanted this feature, and -I wanted to be able to add additional features to it without having -to keep a close eye on Speedflow development (lest it break under -my nose). And, well, here we are. Much appreciation to the Speedflow -developers for all their hard work! +the 3D View window, in a slightly configurable manner. + +This idea (and much of the original code) was blatantly stolen from +from the Speedflow (), +whose features I've found I don't really need -- but I loved the +overlays! The original Speedflow code has been hacked almost beyond +recognizability, but you can still see bits of the original if you +look. + +This addon should definitely be considered beta quality at best, but +it works well for me! I will *gladly* fix any problems found if they are +reported (via Github issue, ideally, but I'll also take email, text +message, smoke signals...). + +If you get no text in the 3D viewport, something is probably crashing -- +check the Blender console, and if it's dumping out a bunch of errors, +open an issue with the error text. I'll probably make it better about +catching its own errors in the future. + +I hope someone finds this addon useful!