From 9972273f47ab1a4e5ee8c699deccbf98c9c3f434 Mon Sep 17 00:00:00 2001 From: Joel Gomes da Silva Date: Thu, 23 Apr 2020 20:48:58 -0300 Subject: [PATCH] Added a new README.rst file to fit PyPI standards. --- README.md | 2 -- README.rst | 25 +++++++++++++++++++++++++ setup.cfg | 2 +- 3 files changed, 26 insertions(+), 3 deletions(-) delete mode 100644 README.md create mode 100644 README.rst diff --git a/README.md b/README.md deleted file mode 100644 index b4efe10..0000000 --- a/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# Fake Blender 2.79 Python API -Fake Blender 2.79 Python API for code completion, including all modules documented on API. \ No newline at end of file diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..febc1be --- /dev/null +++ b/README.rst @@ -0,0 +1,25 @@ +Fake Blender 2.79 Python API +============================= + +Fake Blender 2.79 Python API for code completion, including all modules documented on API. + +To use this API you just need a Python 3.x distribution and a text editor with advanced +code completion (PyCharm, PyScripter, Visual Studio Code with Python plugins, etc). + +This project is based on nutti's fake-bpy-module_, however it's not auto-generated as the +former. It also includes some missing modules of the fake-bpy-module such as bge and id_prop, +and it aims to be more accurate in the data types. + +Installation +------------- + +Just type in the command line of your computer: + +``pip install fake-blender-api-2.79`` + +And you're ready to take advantage of Blender code completion on your favorite text editor! +Just make sure you installed it on the same Python interpreter that your text is using. + +Enjoy! + +.. _fake-bpy-module: https://github.com/nutti/fake-bpy-module \ No newline at end of file diff --git a/setup.cfg b/setup.cfg index 224a779..11e9ec4 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,2 +1,2 @@ [metadata] -description-file = README.md \ No newline at end of file +description-file = README.rst \ No newline at end of file