Skip to content
Permalink
Browse files

Add README for plugin building and additional targets in base Makefile

  • Loading branch information...
captainhammy committed Aug 17, 2019
1 parent 5ad638b commit e48d092749ed0ce57d8ec46ff1d6d1969e016e9d
Showing with 61 additions and 2 deletions.
  1. +16 −2 Makefile
  2. +45 −0 plugins/README.md
@@ -3,15 +3,29 @@
build-icons:
pyside2-rcc -o python/ht/ui/icons.py icons/icons.qrc

# Envoke hcmake and make to build all plugins.
# Invoke hcmake and make to build all plugins.
build-plugins:
mkdir -p ${CURDIR}/plugins/build
cd ${CURDIR}/plugins/build && hcmake .. && make

# Build a single plugin: build-plugin PLUGIN={PLUGIN_NAME}
build-plugin:
mkdir -p ${CURDIR}/plugins/build
cd ${CURDIR}/plugins/build && hcmake .. && make ${PLUGIN}

# Clean built plugins.
clean-plugins:
cd ${CURDIR}/plugins/build && make clean

# List all available plugins
list-targets:
cd ${CURDIR}/plugins/build && make help

# Initialize the build location and run cmake
init-build:
mkdir -p ${CURDIR}/plugins/build
cd ${CURDIR}/plugins/build && hcmake ..

# Run Python unit tests
run-tests:
hython bin/run_tests.py

@@ -0,0 +1,45 @@
The compiled HDK plugins for **Houdini Toolbox** can be built using CMake and the custom wrapper **hcmake**

## Building The Plugins

To compile the plugins do the following from the root Houdini-Toolbox directory:
```
$> mkdir plugins/build
$> cd plugins/build
$> hcmake .. # This will invoke Cmake in a Houdini environment
$> make
```
### Individual plugins
To build an individual plugin you must do the first 3 steps above and then:
```
$> cd plugins/build
$> make {PLUGIN_NAME} # see 'make help' for details
```

### Cleaning
To clean the plugin files:
```
$> cd plugins/build
$> make clean
```

## Using Houdini Toolbox Makefile
The root Houdini-Toolbox directory also contains a Makefile with convenient targets for building the plugins:

```
# Build all the plugins
$> make build-plugins
# Initialize the Cmake generated files but don't build anything
$> make init-build
# Get a list of plugins
$> make list-targets
# Build a specific plugin
$> make build-plugin PLUGIN={PLUGIN NAME}
# Clean all the plugins
$> make clean-plugins
```

0 comments on commit e48d092

Please sign in to comment.
You can’t perform that action at this time.