Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/main' into updev
Browse files Browse the repository at this point in the history
  • Loading branch information
James Bradbury committed Mar 30, 2022
2 parents 421107f + 5f9cf25 commit cbe3b9d
Show file tree
Hide file tree
Showing 2 changed files with 108 additions and 74 deletions.
95 changes: 95 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
name: Release
on:
workflow_dispatch:
inputs:
base:
description: 'Base branch to deploy core from'
required: false
default: 'main'

jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: flucoma/actions/env@v4
with:
branch: ${{ github.event.inputs.base }}
- uses: flucoma/actions/docs@v4
with:
target: MAKE_MAX_REF
branch: ${{ github.event.inputs.base }}

- uses: actions/upload-artifact@v2
with:
name: docsbuild
path: build/max_ref

winbuild:
runs-on: windows-latest
steps:
- uses: actions/checkout@v2
- uses: flucoma/actions/env@v4
with:
branch: ${{ github.event.inputs.base }}
- uses: flucoma/actions/max@v4

- uses: actions/upload-artifact@v2
with:
name: winbuild
path: "release-packaging/FluidCorpusManipulation/externals/"

macbuild:
runs-on: macos-11
outputs:
version: ${{ steps.get-version.outputs.version }}
steps:
- uses: actions/checkout@v2
- uses: flucoma/actions/env@v4
with:
branch: ${{ github.event.inputs.base }}
- uses: flucoma/actions/max@v4

- uses: actions/upload-artifact@v2
with:
name: macbuild
path: release-packaging/FluidCorpusManipulation/

- id: get-version
run: echo "::set-output name=version::$(cat flucoma.version.rc)"
working-directory: core

release:
runs-on: ubuntu-latest
needs: [winbuild, macbuild, docs]

steps:
- name: make parent folder
run : mkdir -p "FluidCorpusManipulation"

- uses: actions/download-artifact@v2
with:
name: macbuild
path: "FluidCorpusManipulation"

- uses: actions/download-artifact@v2
with:
name: winbuild
path: "FluidCorpusManipulation/externals"

- uses: actions/download-artifact@v2
with:
name: docsbuild
path: "FluidCorpusManipulation/docs"

- name: zip
run: zip -r FluCoMa-Max-"${{ needs.macbuild.outputs.version }}".zip "FluidCorpusManipulation"

- name: package and upload
uses: softprops/action-gh-release@v1
with:
name: ${{ needs.macbuild.outputs.version }}
body: "This is a release build of the FluCoMa Max package. The build hash is ${{ github.sha }}"
files: FluCoMa*.zip
prerelease: true
tag_name: ${{ needs.macbuild.outputs.version }}
draft: false
87 changes: 13 additions & 74 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,89 +2,28 @@

This repository hosts code for generating the Max objects and documentation resources for the Fluid Corpus Manipulation Project. Much of the actual code that does the exciting stuff lives in this repository's principal dependency, the [Fluid Corpus Manipulation Library](https://github.com/flucoma/flucoma-core).

# Minimal Quick Build

# How to build
Minimal build steps below. For detailed guidance see https://github.com/flucoma/flucoma-max/wiki/Compiling

## Pre-requisites
## Prerequisites

* [CMake](http://cmake.org) >= 3.11
* A C++ 14 compliant compiler for Mac or Windows (via XCode tools on Mac, and Visual Studio 17 >= 15.9 on Windows)
* C++14 compliant compiler (clang, GCC or MSVC)
* cmake
* make (or Ninja or XCode or VisualStudio)
* git
* an internet connection
* [Max SDK](https://github.com/Cycling74/max-sdk) (>= 7.3.3)

## Dependencies
CMake will automatically download the dependencies needed

* [Max SDK](https://github.com/Cycling74/max-sdk) (>= 7.3.3) : this is the only dependency we don't (optionally) manage for you, so there must be a version available to point to when you run, using the CMake Variable `MAX_SDK_PATH` (see below). It can live anywhere on your file system, although often it is convenient to install directly into your Max packages folder.

These will be downloaded and configured automatically, unless you pass CMake a source code location on disk for each (see below):

* [Fluid Corpus Manipulation Library](https://github.com/flucoma/flucoma-core)
* [Eigen](https://gitlab.com/libeigen/eigen) (3.3.5)
* [HISSTools Library](https://github.com/AlexHarker/HISSTools_Library)


## I'm in a Hurry...

...and you already have a development environment set up, understand CMake, and have the Max SDK available? And Python 3 + DocUtils + Jinja if you want docs?

Cool:

```
```bash
mkdir -p build && cd build
cmake -DMAX_SDK_PATH=<location of your Max SDK> -DDOCS=<ON/OFF> ..
cmake -DMAX_SDK_PATH=</path/to/sdk> ..
make install
```

This will assemble a Max package in `release-packaging`.

An alternative to setting up / running CMake directly on the command line is to install the CMake GUI, or use to use the curses GUI `ccmake`.

Also, with CMake you have a choice of which build system you use.

* The default on macOS and Linux is `Unix Makefiles`. On macOS you can also use Xcode by passing `-GXcode` to CMake when you first run it.
* The default on Windows is the latest version of Visual Studio installed. However, Visual Studio can open CMake files directly as projects, which has some upsides. When used this way, CMake variables have to be set via a JSON file that MSVC will use to configure CMake.


## Generating Documentation

The documentation partially relies on a system that is shared with other wrappers of the Fluid Corpus Manipulation Project for different creative coding environments.

Pre-requisites:

* Python 3
* Docutils python package (ReST parsing)
* Jinja python package (template engine)
* PyYAML >= 5.1 (YAML parsing)

To generate `maxref.xml` documentation for the Max objects requires a further dependency, [flucoma-docs](https://github.com/flucoma/flucoma-docs), which we use to combine generated and human-written docs. We then pass `DOCS=ON` to CMake
```
cmake -DDOCS=ON ..
```
Unless we pass the location on disk of `flucoma-docs`, CMake will again take care of downloading this dependency.

This process:

* has only ever been tested on Mac, so may well not work at all on Windows
* can sometimes produce spurious warnings in Xcode, but *should* work


## Using Manual Dependencies

In some cases you may want to use your own copies of the required libraries. Unless specified, the build system will download these automatically. To bypass this behavior, use the following cache variables:

* `FLUID_PATH`: location of the Fluid Corpus Manipulation Library
* `FLUID_DOCS_PATH`: location of `flucoma-docs` repository (e.g. for debugging documentation generation)
* `EIGEN_PATH` location of the Eigen library
* `HISS_PATH` location of the HISSTools library

For example, use this to use your own copy of the Fluid Corpus Manipulation Library
```
cmake -DMAX_SDK_PATH=<location of your Max SDK> -DFLUID_PATH=<location of Fluid Corpus Manipulation Library> ..
```

To find out which branches / tags / commits of these we use, look in the top level `CMakeLists.txt` of the Fluid Corpus Manipulation Library for the `FetchContent_Declare` statements for each dependency.

## Compiling for different CPUs

The build system generally assumes an x86 cpu with AVX instructions (most modern x86 CPUs). To build on another kind of CPU (e.g. older than 2012) you can use the `FLUID_ARCH` cache variable to pass specific flags to your compiler. For example use `-DFLUID_ARCH=-mcpu=native` to optimize for your particular CPU.
This will assemble a package in `release-packaging`.

## Credits
#### FluCoMa core development team (in alphabetical order)
Expand Down

0 comments on commit cbe3b9d

Please sign in to comment.