From 366cf77d3691d462560473378b9f5d76d279b35a Mon Sep 17 00:00:00 2001 From: "mic.schwarz" <089michael@gmail.com> Date: Tue, 9 Jan 2018 18:32:24 +0100 Subject: [PATCH] Add README.md --- README.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..a49e8e6 --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +# easyText + +[![Maintainability](https://api.codeclimate.com/v1/badges/9aa888b165f41c9f6d94/maintainability)](https://codeclimate.com/github/micschwarz/easyText/maintainability) + +A Blender Plugin for easy text creation + +## Getting Started + +Clone Project + +``` +git clone +``` + +### Prerequisites + +* [Blender](https://www.blender.org/) (v2.77+) +* [Python](https://www.python.org/) (v3.5+, only for developement) + + + +### Installing in Blender + +1. Go into settings ``File > User Preferences`` +2. Choose ``Add-ons`` Tab +3. Click ``Install Add-on from File`` +4. Restart Blender + +### Development with live test + +1. Open Blender Config folder
+ (On Windows it's `USER_DIR\AppData\Roaming\Blender Foundation\Blender\BLENDER_VERSION\`) +2. Open Script Location `\scripts\addons\easyText_0_6` in your IDE +3. After chance hit `F8` in Blender to reload all plugins + +Tip: For console drag the 3D Viewport Border from the top a little down + +## Versioning + +I'm using [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags). \ No newline at end of file