Skip to content

Commit

Permalink
changes to README (#7821)
Browse files Browse the repository at this point in the history
* changes to README

* Update README.md
  • Loading branch information
yudong1013 authored Oct 7, 2024
1 parent 54e78fb commit 60ee667
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ how (this shows the result on Mac, but Windows and Linux are similar).
First, configure a build with Python bindings activated:

```
cmake -Bignore/bpy -DSURGE_BUILD_PYTHON_BINDINGS -DCMAKE_BUILD_TYPE=Release
cmake -Bignore/bpy -DSURGE_BUILD_PYTHON_BINDINGS=ON -DCMAKE_BUILD_TYPE=Release
```

Note the directory `ignore/bpy` could be anything you want. The `ignore`
Expand All @@ -159,6 +159,14 @@ which should result in the Python .dll being present:
ignore/bpy/src/surge-python/surgepy.cpython-311-darwin.so
```

on Windows, look for the `.pyd` file instead:

```bash
ls ignore/bpy/src/surge-python/Debug/*pyd
```

and you should see a file like `surgepy.cp312-win_amd64.pyd`

Now you can finally start Python to load that. Here is an example interactive
session, but it will work similarly in the tool of your choosing:

Expand All @@ -174,6 +182,8 @@ Type "help", "copyright", "credits" or "license" for more information.
>>> quit()
```

on Windows, run `sys.path.append("ignore/bpy/src/surge-python/Debug")` instead, as the path is slightly different.

## Building an Installer

The CMake target `surge-xt-distribution` builds an install image on your platform at the end of the build process. On
Expand Down

0 comments on commit 60ee667

Please sign in to comment.