Skip to content

Commit

Permalink
Added a new README.rst file to fit PyPI standards.
Browse files Browse the repository at this point in the history
  • Loading branch information
joelgomes1994 committed Apr 23, 2020
1 parent 7a2d05b commit 9972273
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 3 deletions.
2 changes: 0 additions & 2 deletions README.md

This file was deleted.

25 changes: 25 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
[metadata]
description-file = README.md
description-file = README.rst

0 comments on commit 9972273

Please sign in to comment.