From f4987adae2107bcac4a5d87cc5ab17285cd69bd2 Mon Sep 17 00:00:00 2001 From: Jacob Wharrie <32973688+jwharrie@users.noreply.github.com> Date: Mon, 5 Nov 2018 18:04:26 -0800 Subject: [PATCH 1/3] Edits to README.md Edited the "highly customizable and flexible..." bullet point of features section. Changed "...a node editor and custom scripting language, named Maxim" to "...a node editor and Maxim, a custom scripting language." The edit clarifies that it's only the custom scripting language that is called Maxim (if that is what you meant). Edited presentation of instructions in building backend. The two separate instructions are in bullets and are each preceded by a bolded title . It is now clear to the reader that there are two options in building backends. --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index eddfbd76..b142ba78 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Axiom is an extremely flexible node-based realtime audio synthesizer. It was ori Features: - Musician-friendly (ie knobs and sliders) interface - - Highly customizable and flexible through a node editor and custom scripting language, named Maxim + - Highly customizable and flexible through a node editor and Maxim, a custom scripting language - Export to replayer with no dependencies (not even the standard library) - Use any DAW with VSTi support for note editing and automation @@ -43,13 +43,17 @@ cmake ../path/to/source -DAXIOM_STATIC_LINK=ON -DVST2_SDK_ROOT=/path/to/vst/sdk CMake will setup files necessary for building. If this fails, make sure you've got Cargo, Qt, LLVM, and the VST SDK installed correctly. Once complete, you can choose which backend to build: -To build the VST2 instrument backend, use the following command. You will need to specify a path to the VST2 SDK. You can also build the VST2 effect with the `axiom_vst2_effect` target. +**VST2 Instrument** + +* To build the VST2 instrument backend, use the following command. You will need to specify a path to the VST2 SDK. You can also build the VST2 effect with the `axiom_vst2_effect` target. ``` cmake --build ./ --target axiom_vst2_instrument ``` -To build the standalone version as an executable, use the following command. In order to enable audio output in this version, the PortAudio library must be installed. You can still use the standalone editor without it, the graph just won't be simulated. +**Standalone** + +* To build the standalone version as an executable, use the following command. In order to enable audio output in this version, the PortAudio library must be installed. You can still use the standalone editor without it, the graph just won't be simulated. ``` cmake --build ./ --target axiom_standalone From 87532ad847f54e7a20b7201430ab9060fe8a17af Mon Sep 17 00:00:00 2001 From: Jacob Wharrie <32973688+jwharrie@users.noreply.github.com> Date: Wed, 7 Nov 2018 15:36:03 -0800 Subject: [PATCH 2/3] Edit README.md 2 Reformatted VST2 and Standalone Headings as markdown headings. Changed heading "VST2 Instrument" to "VST2 Instrument & VST2 Effect" to clarity that the section contains instructions for both builds. --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b142ba78..80089ab3 100644 --- a/README.md +++ b/README.md @@ -43,15 +43,19 @@ cmake ../path/to/source -DAXIOM_STATIC_LINK=ON -DVST2_SDK_ROOT=/path/to/vst/sdk CMake will setup files necessary for building. If this fails, make sure you've got Cargo, Qt, LLVM, and the VST SDK installed correctly. Once complete, you can choose which backend to build: -**VST2 Instrument** - -* To build the VST2 instrument backend, use the following command. You will need to specify a path to the VST2 SDK. You can also build the VST2 effect with the `axiom_vst2_effect` target. +###VST2 Instrument & VST2 Effect +* To build the VST2 instrument backend, use the following command. You will need to specify a path to the VST2 SDK. ``` cmake --build ./ --target axiom_vst2_instrument ``` -**Standalone** +* You can also build the VST2 effect with the `axiom_vst2_effect` target. +``` +cmake --build ./ --target axiom_vst2_effect +``` + +###Standalone * To build the standalone version as an executable, use the following command. In order to enable audio output in this version, the PortAudio library must be installed. You can still use the standalone editor without it, the graph just won't be simulated. From 959cb42039da3fbf389d299f81bd9a3cc58f7229 Mon Sep 17 00:00:00 2001 From: Jacob Wharrie <32973688+jwharrie@users.noreply.github.com> Date: Wed, 7 Nov 2018 15:36:58 -0800 Subject: [PATCH 3/3] Minor Correction for Headings --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 80089ab3..33619b9a 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ cmake ../path/to/source -DAXIOM_STATIC_LINK=ON -DVST2_SDK_ROOT=/path/to/vst/sdk CMake will setup files necessary for building. If this fails, make sure you've got Cargo, Qt, LLVM, and the VST SDK installed correctly. Once complete, you can choose which backend to build: -###VST2 Instrument & VST2 Effect +### VST2 Instrument & VST2 Effect * To build the VST2 instrument backend, use the following command. You will need to specify a path to the VST2 SDK. ``` @@ -55,7 +55,7 @@ cmake --build ./ --target axiom_vst2_instrument cmake --build ./ --target axiom_vst2_effect ``` -###Standalone +### Standalone * To build the standalone version as an executable, use the following command. In order to enable audio output in this version, the PortAudio library must be installed. You can still use the standalone editor without it, the graph just won't be simulated.