added better readme

Author: cheng-chi

README.md

@@ -1 +1,39 @@
-# blender_ipython
+# Blender Notebook
+
+A simple command line tool to wrap blender 2.8+ as a jupyter kernel.
+
+Blender's python API requires its embedded python interpreter. As of Blender 2.82, python 3.7 is packaged. In order to make ipykernel and other pip packages accessible to Blender, the `site-packages` directory of the python interpreter executing blender_notebook will be added to Blender's python path. Therefore, it's highly recommended to use exactly the same python version as your blender.
+
+## Installation
+
+The easiest way to install blender_notebook is via pip:
+```
+$ python -m pip install blender_notebook
+```
+
+It can also be installed from source:
+```
+$ python -m pip install -e .
+```
+
+## Usage
+
+If blender in installed by a package manager, the easiest way to find the executable path is:
+```
+$ which blender
+/snap/bin/blender
+```
+In my case, blender is installed from snap.
+
+Then, run the blender_notebook CLI:
+```
+$ blender_notebook install --blender-exec /snap/bin/blender
+Saving files to ~/.local/share/jupyter/kernels/blender
+```
+
+You can also delete the kernel:
+```
+$ blender_notebook remove
+Are you sure to delete ~/.local/share/jupyter/kernels/blender ? [y/N]: y
+blender jupyter kernel is removed!
+```

blender_notebook/installer.py

@@ -55,7 +55,6 @@ def install(blender_exec, kernel_dir, kernel_name):
         raise RuntimeError("Invalid blender executable path!")
 
     kernel_path = get_kernel_path(kernel_dir)
-    print(kernel_path)
 
     kernel_install_path = kernel_path.joinpath(kernel_name)
     if kernel_install_path.exists():

setup.py

@@ -1,9 +1,14 @@
 from setuptools import setup
+import pathlib
+with pathlib.Path(__file__).parent.joinpath('README.md').open('r', encoding='utf-8') as f:
+    long_description = f.read()
 
 setup(
     name = "blender_notebook",
     version = "0.0.1",
-    description = "Script to wrap blender as a jupyter kernel",
+    description = "A simple command line tool to wrap blender 2.8+ as a jupyter kernel",
+    long_description = long_description,
+    long_description_content_type = 'text/markdown',
     author = "Cheng Chi",
     author_email = "[email protected]",
     license = "MIT",