Skip to content

Commit

Permalink
update README.md for initial beta release
Browse files Browse the repository at this point in the history
  • Loading branch information
alinsavix committed Jan 29, 2021
1 parent 48d80a6 commit f375ad6
Showing 1 changed file with 21 additions and 9 deletions.
30 changes: 21 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
(<https://blendermarket.com/products/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 (<https://blendermarket.com/products/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!

0 comments on commit f375ad6

Please sign in to comment.