Skip to content

Commit

Permalink
[refactored] Renamed the wrong adaptions directory finally to adaptat…
Browse files Browse the repository at this point in the history
…ions. This should not break any install because the adaptions directory never made it into the installer and onto the targt computer.
  • Loading branch information
christofmuc committed Aug 8, 2023
1 parent e0d967e commit 8855c94
Show file tree
Hide file tree
Showing 162 changed files with 26 additions and 26 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/builds-windows.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ jobs:
- name: Run Python tests first
run: |
pip install -r requirements.txt
cd adaptions
cd adaptations
python -m pytest --all . -q --no-header
- name: CMake build
Expand Down
8 changes: 4 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
builds/
*__pycache__*
.idea/
adaptions/CompiledAdaptions.h
adaptations/CompiledAdaptions.h
third_party/Tools.InnoSetup.6.0.5/
builds6/
The-Orm/sentry-config.h
adaptions/CompiledAdaptations.h
adaptations/CompiledAdaptations.h
codesigning/dsa_priv.pem
builds.old/
cmake-build-debug/
build_python310/
adaptions/testData/TORAIZ Artist Sound Pack Agreement.pdf
adaptions/testData/Toraiz AS-1 Synth Sunset Bank.tas1_bank
adaptations/testData/TORAIZ Artist Sound Pack Agreement.pdf
adaptations/testData/Toraiz AS-1 Synth Sunset Bank.tas1_bank
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ add_subdirectory(synths/sequential-ob6)
add_subdirectory(synths/yamaha-refacedx)

# Add the generic adaptations module, that allows to define synths via Python
add_subdirectory(adaptions)
add_subdirectory(adaptations)

# Add the pytchirp module that exposes the synths to Python
add_subdirectory(pytschirp)
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,9 +101,9 @@ This software is build and run on Windows 10, macOS 10.15, and several Linux dis

It is possible to create an adaptation for a new synthesizer that is not yet on the supported device list. For that, you'll select an existing adaptation that might be close to what you need (e.g. same manufacturer, same device family), and use a text editor to adapt the Python code controlling how to generate the device specific messages required and what to do with the answers from the synth.

If you're up to that, I have written a whole [Programming Guide](https://github.com/christofmuc/KnobKraft-orm/blob/master/adaptions/Adaptation%20Programming%20Guide.md) documenting the required and optional methods to be implemented.
If you're up to that, I have written a whole [Programming Guide](https://github.com/christofmuc/KnobKraft-orm/blob/master/adaptations/Adaptation%20Programming%20Guide.md) documenting the required and optional methods to be implemented.
To make sure your code works, you can run it through a generic test suite that all adaptations must pass, find more information
in the [Adaptation Testing Guide](https://github.com/christofmuc/KnobKraft-orm/blob/master/adaptions/Adaptation%20Testing%20Guide.md), please check it out!)
in the [Adaptation Testing Guide](https://github.com/christofmuc/KnobKraft-orm/blob/master/adaptations/Adaptation%20Testing%20Guide.md), please check it out!)

I know this is not easy, and most importantly new devices also might require capabilities that are not yet part of the Orm, so please don't hesitate to contact me, I'll try to help!

Expand Down
10 changes: 5 additions & 5 deletions The-Orm/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -241,25 +241,25 @@ ENDIF()
# Installation - we want to copy the sequential module directory as a subdirectory to the binary output dir. Same with roland and knobkraft python modules
add_custom_command(TARGET KnobKraftOrm POST_BUILD
COMMAND ${CMAKE_COMMAND} -E copy_directory
${CMAKE_SOURCE_DIR}/adaptions/sequential
${CMAKE_SOURCE_DIR}/adaptations/sequential
$<TARGET_FILE_DIR:KnobKraftOrm>/sequential
)
add_custom_command(TARGET KnobKraftOrm POST_BUILD
COMMAND ${CMAKE_COMMAND} -E copy_directory
${CMAKE_SOURCE_DIR}/adaptions/roland
${CMAKE_SOURCE_DIR}/adaptations/roland
$<TARGET_FILE_DIR:KnobKraftOrm>/roland
)
add_custom_command(TARGET KnobKraftOrm POST_BUILD
COMMAND ${CMAKE_COMMAND} -E copy_directory
${CMAKE_SOURCE_DIR}/adaptions/knobkraft
${CMAKE_SOURCE_DIR}/adaptations/knobkraft
$<TARGET_FILE_DIR:KnobKraftOrm>/knobkraft
)
add_custom_command(TARGET KnobKraftOrm POST_BUILD
COMMAND ${CMAKE_COMMAND} -E copy_directory
${CMAKE_SOURCE_DIR}/adaptions/testing
${CMAKE_SOURCE_DIR}/adaptations/testing
$<TARGET_FILE_DIR:KnobKraftOrm>/testing
)
file(GLOB ADAPTATION_PYTHON_FILES "${CMAKE_SOURCE_DIR}/adaptions/*.py")
file(GLOB ADAPTATION_PYTHON_FILES "${CMAKE_SOURCE_DIR}/adaptations/*.py")
list(FILTER ADAPTATION_PYTHON_FILES EXCLUDE REGEX "conftest.py")
list(FILTER ADAPTATION_PYTHON_FILES EXCLUDE REGEX "test_.*py")
list(FILTER ADAPTATION_PYTHON_FILES EXCLUDE REGEX "DSI_OB6.py")
Expand Down
8 changes: 4 additions & 4 deletions The-Orm/setup.iss
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,10 @@ Source: "${CMAKE_CURRENT_BINARY_DIR}\RelWithDebInfo\icudt67.dll"; DestDir: "{app
Source: "${CMAKE_CURRENT_BINARY_DIR}\RelWithDebInfo\sentry.dll"; DestDir: "{app}"; Flags: skipifsourcedoesntexist ignoreversion
Source: "${CMAKE_CURRENT_BINARY_DIR}\RelWithDebInfo\crashpad_handler.exe"; DestDir: "{app}"; Flags: skipifsourcedoesntexist ignoreversion
Source: "${CMAKE_CURRENT_BINARY_DIR}\RelWithDebInfo\WinSparkle.dll"; DestDir: "{app}"; Flags: skipifsourcedoesntexist ignoreversion
Source: "${CMAKE_SOURCE_DIR}\adaptions\sequential\*.*"; DestDir: "{app}\sequential";Flags: ignoreversion
Source: "${CMAKE_SOURCE_DIR}\adaptions\roland\*.*"; DestDir: "{app}\roland";Flags: ignoreversion
Source: "${CMAKE_SOURCE_DIR}\adaptions\knobkraft\*.*"; DestDir: "{app}\knobkraft";Flags: ignoreversion
Source: "${CMAKE_SOURCE_DIR}\adaptions\testing\*.*"; DestDir: "{app}\testing";Flags: ignoreversion
Source: "${CMAKE_SOURCE_DIR}\adaptations\sequential\*.*"; DestDir: "{app}\sequential";Flags: ignoreversion
Source: "${CMAKE_SOURCE_DIR}\adaptations\roland\*.*"; DestDir: "{app}\roland";Flags: ignoreversion
Source: "${CMAKE_SOURCE_DIR}\adaptations\knobkraft\*.*"; DestDir: "{app}\knobkraft";Flags: ignoreversion
Source: "${CMAKE_SOURCE_DIR}\adaptations\testing\*.*"; DestDir: "{app}\testing";Flags: ignoreversion
#include "adaptations.iss"
; NOTE: Don't use "Flags: ignoreversion" on any shared system files
; VC++ redistributable runtime. Extracted by VC2017RedistNeedsInstall(), if needed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ The data types used in the interface between the main program and the adaptation

Now is a good time, before jumping right into the programming exercise, to think about how you will test that
your adaptation code actually works. For this, I have written the
[Adaptation Testing Guide](https://github.com/christofmuc/KnobKraft-orm/blob/master/adaptions/Adaptation%20Testing%20Guide.md),
[Adaptation Testing Guide](https://github.com/christofmuc/KnobKraft-orm/blob/master/adaptations/Adaptation%20Testing%20Guide.md),
please check it out!

# List of functions to implement
Expand Down Expand Up @@ -785,11 +785,11 @@ The KnobKraft Orm ships with quite a few examples of adaptations.

All existing adaptations can be found in the directory with the source code, or here at github at

https://github.com/christofmuc/KnobKraft-orm/tree/master/adaptions
https://github.com/christofmuc/KnobKraft-orm/tree/master/adaptations

To give you a quick overview which adaptation actually has implemented which functions and capabilities, there is am overview table that you can consult, especially for finding one of the more obscure function usages:

https://github.com/christofmuc/KnobKraft-orm/blob/master/adaptions/implementation_overview.md
https://github.com/christofmuc/KnobKraft-orm/blob/master/adaptations/implementation_overview.md


The adaptations that are shipped with the KnobKraft Orm are stored in the adaptations subdirectory of the program directory. Check them out there as well.
Original file line number Diff line number Diff line change
Expand Up @@ -40,17 +40,17 @@ on Linux you'll do
With the virtual env activated, we can use the pip package manager to install the required packages for running the tests.
Just do

pip install -r .\adaptions\requirements.txt
pip install -r .\adaptations\requirements.txt

which will install the pytest package and other prerequisites.


## Running the tests

All tests are implemented as pytest tests, so the correct way to run them all is use the standard method for pytests, just
type in your prepared virtual environment, make sure to cd into the adaptions subdirectory:
type in your prepared virtual environment, make sure to cd into the adaptations subdirectory:

cd adaptions
cd adaptations
python -m pytest . --all

This should be run in the source's root directory.
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

Large diffs are not rendered by default.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions docs/Adaptation Programming Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -738,11 +738,11 @@ The KnobKraft Orm ships with quite a few examples of adaptations.

All existing adaptations can be found in the directory with the source code, or here at github at

https://github.com/christofmuc/KnobKraft-orm/tree/master/adaptions
https://github.com/christofmuc/KnobKraft-orm/tree/master/adaptations

To give you a quick overview which adaptation actually has implemented which functions and capabilities, there is am overview table that you can consult, especially for finding one of the more obscure function usages:

https://github.com/christofmuc/KnobKraft-orm/blob/master/adaptions/implementation_overview.md
https://github.com/christofmuc/KnobKraft-orm/blob/master/adaptations/implementation_overview.md


The adaptations that are shipped with the KnobKraft Orm are stored in the adaptations subdirectory of the program directory. Check them out there as well.

0 comments on commit 8855c94

Please sign in to comment.