Skip to content

Commit

Permalink
fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
minitoine committed Aug 27, 2019
1 parent 0162845 commit 9139a7a
Showing 1 changed file with 30 additions and 3 deletions.
33 changes: 30 additions & 3 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,27 +7,40 @@
### 1.1] CGAL
Esquisse uses [CGAL](https://www.cgal.org) to export SVG files.
We need to build a wrapper to call specific functions in python.

#### Installing CGAL
* Install CGAL using HomeBrew or MacPorts on your computer

> brew install cgal
#### Installing swig
* Install swig using HomeBrew or MacPorts on your computer

> brew install swig
#### Building the wrapper
* go in folder **wrapper_cgal**
* Please check the path to CGAL library in **setup.py** (probably update the version)
> library_dirs = ['/usr/local/Cellar/cgal/4.12/lib']
* Please check the path to the CGAL library in **setup.py** (probably update the version)

> library_dirs = ['/usr/local/Cellar/cgal/**X.X**/lib']
* run Makefile

> make
**Warning:** Be carefull to match the python version called by Makefile and the python version of Blender

#### Install the wrapper into Esquisse
* copy **mycgal.py** and **mycgal.so** into **/code/Esquisse/cgal**

### 1.2] svg.path
Esquisse uses [svg.path](https://pypi.org/project/svg.path/) to export SVG files.

#### Getting svg.path
* Install svg.path using pip

> pip3 install svg.path
#### Installing svg.path into Esquisse
* The module downloaded should be located in your python installation folder (probably /usr/local/lib/python3.X)
* Open the the directory **site-packages** inside the python folder
Expand All @@ -36,11 +49,15 @@ Esquisse uses [svg.path](https://pypi.org/project/svg.path/) to export SVG files

### 1.3] Polygon3
Esquisse uses [Polygon3](https://pypi.org/project/Polygon3/) to export SVG files.

#### Getting Polygon
* Install Polygon3 using pip

**Warning:** Be carefull to match the python version of Polygon3 and the python version of Blender because we are using
a dynamic library. We recommend to use pyenv to change python version.

> pip3 install Polygon3
#### Installing Polygon3 into Esquisse
* The module downloaded should be located in your python installation folder (probably /usr/local/lib/python3.X)
* Open the the directory **site-packages** inside the python folder
Expand All @@ -49,9 +66,12 @@ a dynamic library. We recommend to use pyenv to change python version.

### 1.4] OpenCV
Esquisses uses [OpenCV](https://pypi.org/project/pyopencv/) to manipulate images.

#### Getting OpenCV
* Install opencv using pip

> pip3 install opencv-python
#### Installing Polygon3 into Esquisse
* The module downloaded should be located in your python installation folder (probably /usr/local/lib/python3.X)
* Open the the directory **site-packages** inside the python folder
Expand All @@ -60,22 +80,30 @@ Esquisses uses [OpenCV](https://pypi.org/project/pyopencv/) to manipulate images

### 1.5] LeapMotion (optional)
Esquisses uses [LeapMotion](https://www.leapmotion.com) to manipulate 3D hands.

#### Getting LeapMotion library
* Download the python SDK from the LeapMotion website
* Move the downloaded files **Leap.h**, **LeapMath.h**, **Leap.i** and **libLeap.dylib** into **wrapper_LeapMotion**

#### Building the wrapper
* go in folder **wrapper_LeapMotion** and run Makefile

> make
**Warning:** Be carefull to match the python version called by Makefile and the python version of Blender

#### Installing the wrapper into Esquisse
* copy **Leap.py**, **libLeap.dylib** and **Leap.so** into **/code/Esquisse/LeapMotion**

## 2] Installing the add-on in Blender

### Creating the add-on
Simply create a zip of the **code/Esquisse** folder

### Installing the add-on in Blender
Open Blender preferences (Cmd ,) and Add-ons tab. Click on "Install Add-on from file" and choose created the zip file.
Then click on the checkbox to enable Esquisse

**Warning:** if Esquisse was already installed in Blender, first de-install it by clicking the remove button. It is not compulsory but you can experience side-effects otherwise.


Expand All @@ -90,4 +118,3 @@ Then click on the checkbox to enable Esquisse




0 comments on commit 9139a7a

Please sign in to comment.