From 4a7921ee90971ecba26f80d11bc69a86856e8436 Mon Sep 17 00:00:00 2001 From: falkTX Date: Fri, 11 Feb 2022 14:46:21 +0000 Subject: [PATCH] Rename doc to folder docs Signed-off-by: falkTX --- Makefile | 3 +++ README.md | 23 ++++++++++--------- {doc => docs}/.generate-plugin-licenses.sh | 0 {doc => docs}/BUILDING.md | 0 {doc => docs}/DEBUGGING.md | 0 {doc => docs}/DIFFERENCES.md | 0 docs/FAQ.md | 25 +++++++++++++++++++++ {doc => docs}/LICENSE-PERMISSIONS.md | 0 {doc => docs}/LICENSES.md | 0 {doc => docs}/MODDEVICES.md | 0 {doc => docs}/OVERVIEW.md | 0 {doc => docs}/Screenshot1.png | Bin {doc => docs}/Screenshot2.png | Bin src/Makefile.cardinal.mk | 4 ++-- 14 files changed, 42 insertions(+), 13 deletions(-) rename {doc => docs}/.generate-plugin-licenses.sh (100%) rename {doc => docs}/BUILDING.md (100%) rename {doc => docs}/DEBUGGING.md (100%) rename {doc => docs}/DIFFERENCES.md (100%) create mode 100644 docs/FAQ.md rename {doc => docs}/LICENSE-PERMISSIONS.md (100%) rename {doc => docs}/LICENSES.md (100%) rename {doc => docs}/MODDEVICES.md (100%) rename {doc => docs}/OVERVIEW.md (100%) rename {doc => docs}/Screenshot1.png (100%) rename {doc => docs}/Screenshot2.png (100%) diff --git a/Makefile b/Makefile index 890c0bb..4b6a1f2 100644 --- a/Makefile +++ b/Makefile @@ -255,6 +255,9 @@ install: install -m 755 bin/Cardinal$(APP_EXT) $(DESTDIR)$(PREFIX)/bin/ cp -rL bin/Cardinal.lv2/resources/* $(DESTDIR)$(PREFIX)/share/Cardinal/ +# -------------------------------------------------------------- +# Install step + # -------------------------------------------------------------- .PHONY: carla deps plugins diff --git a/README.md b/README.md index 7782b3f..19ac272 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# DISTRHO Cardinal + *Cardinal, the Rack!* @@ -11,7 +11,7 @@ plugin wrapper around [VCV Rack](https://github.com/VCVRack/Rack/), using its code directly instead of forking the project, with the target of having a **proper, self-contained, fully free and open-source plugin version of Rack**. See the [why section](#Why) below for the reasons Cardinal exists, -also perhaps the [project overview document](doc/OVERVIEW.md) for an overview on how the project source code is structured. +also perhaps the [project overview document](docs/OVERVIEW.md) for an overview on how the project source code is structured. Cardinal contains Rack, some 3rd-party modules and a few internal utilities all in a single binary. All "Core" modules from Rack have been replaced by Cardinal equivalents, simplified to better work for an audio plugin. @@ -54,24 +54,25 @@ Plugin type is set as regular "effect". Because people will ask for it. It is, well... Rack. But a couple of modules background's have their colors flipped, because damn we want proper dark mode! -![screenshot1](doc/Screenshot1.png "Screenshot1") -![screenshot2](doc/Screenshot2.png "Screenshot2") +![screenshot1](docs/Screenshot1.png "Screenshot1") +![screenshot2](docs/Screenshot2.png "Screenshot2") ## Current status With the exception of a few bugs, Cardinal can be considered stable. -Though currently the following features are known NOT to work: +Though currently the following should be noted: -- VST3 support incomplete/experimental [#41](https://github.com/DISTRHO/Cardinal/issues/41) -- Factory (plugin-provided) presets [#58](https://github.com/DISTRHO/Cardinal/issues/58) +- Keyboard input does not always work in some hosts [#24](https://github.com/DISTRHO/Cardinal/issues/24) +- VST3 support incomplete/experimental [#41](https://github.com/DISTRHO/Cardinal/issues/41) [#126](https://github.com/DISTRHO/Cardinal/issues/126) +- Windows 32bit builds do not work well [#80](https://github.com/DISTRHO/Cardinal/issues/80) ### Current builds If you want to try this out early, checkout the [GitHub actions tab](https://github.com/DISTRHO/Cardinal/actions/workflows/build.yml). There is absolutely no warranty, use at your own risk and all that... -Basic building instructions are available in [BUILDING.md](doc/BUILDING.md) +Basic building instructions are available in [BUILDING.md](docs/BUILDING.md) ### Community chat @@ -82,7 +83,7 @@ Come join us in your favorite IRC client or through a Matrix bridge. ## License Cardinal is licensed under GPLv3+, see [LICENSE](LICENSE) for more details. -An overview of the included code and linked submodules can be seen [here](doc/LICENSES.md#code-license--binary). +An overview of the included code and linked submodules can be seen [here](docs/LICENSES.md#code-license--binary). ## Included modules @@ -138,7 +139,7 @@ Online access (such as phone-home) is not allowed. Worth noting that a few modules have artwork licensed separately from their code. These licenses range from CC-0 to CC-NC-ND to custom (used with permission). -An overview of the included artwork licenses can be seen [here](doc/LICENSES.md#artwork--panel-licenses). +An overview of the included artwork licenses can be seen [here](docs/LICENSES.md#artwork--panel-licenses). Even though CC-NC is problematic for packaging (some linux distributions are commercial in nature), Cardinal allows their use because of how prevalent they are across many Rack modules. @@ -188,4 +189,4 @@ In fact, Cardinal wouldn't exist if not for Rack v2 release. (which has many nee Cardinal and Rack should be able to co-exist friendly and peacefully, as they clearly have different targets. It is likely most people will prefer to use Rack Pro for its official support and its big module collection (including commercial ones). -A feature comparison between Cardinal and Rack Pro can be seen [here](doc/DIFFERENCES.md). +A feature comparison between Cardinal and Rack Pro can be seen [here](docs/DIFFERENCES.md). diff --git a/doc/.generate-plugin-licenses.sh b/docs/.generate-plugin-licenses.sh similarity index 100% rename from doc/.generate-plugin-licenses.sh rename to docs/.generate-plugin-licenses.sh diff --git a/doc/BUILDING.md b/docs/BUILDING.md similarity index 100% rename from doc/BUILDING.md rename to docs/BUILDING.md diff --git a/doc/DEBUGGING.md b/docs/DEBUGGING.md similarity index 100% rename from doc/DEBUGGING.md rename to docs/DEBUGGING.md diff --git a/doc/DIFFERENCES.md b/docs/DIFFERENCES.md similarity index 100% rename from doc/DIFFERENCES.md rename to docs/DIFFERENCES.md diff --git a/docs/FAQ.md b/docs/FAQ.md new file mode 100644 index 0000000..7fada29 --- /dev/null +++ b/docs/FAQ.md @@ -0,0 +1,25 @@ +# Frequently Asked Questions + +This document contains a few frequently asked auestions (known as "FAQ") regarding the Cardinal project. + +# Why does Cardinal exist? + +Many reasons, most of them described on the [README](../README.md#why). +But basically we want an open-source plugin version of "Rack Pro", +where we are free to change things as we see fit, work on new features and fix bugs. +This is simply not possible with proprietary software, which is the case of "Rack Pro". + +# Changes are lost on restart + +This is intentional. +Cardinal is meant to be a self-contained plugin, and as such it does not save any files whatsoever. +This includes user preferences (like list of favourites) or last used project. +As a plugin, the state will be saved together with the host/DAW project. + +# On FreeBSD and Linux the menu item "Save As/Export..." does nothing + +The save-file dialogs in Cardinal requires a working [xdg-desktop-portal](https://github.com/flatpak/xdg-desktop-portal) DBus implementation from your desktop environment. +Typically your desktop already provides this, if not consider looking for a package to install with "desktop-portal" in the name. + +The open-file dialogs in Cardinal do not have this restriction, with a fallback in case desktop portal is not available. + diff --git a/doc/LICENSE-PERMISSIONS.md b/docs/LICENSE-PERMISSIONS.md similarity index 100% rename from doc/LICENSE-PERMISSIONS.md rename to docs/LICENSE-PERMISSIONS.md diff --git a/doc/LICENSES.md b/docs/LICENSES.md similarity index 100% rename from doc/LICENSES.md rename to docs/LICENSES.md diff --git a/doc/MODDEVICES.md b/docs/MODDEVICES.md similarity index 100% rename from doc/MODDEVICES.md rename to docs/MODDEVICES.md diff --git a/doc/OVERVIEW.md b/docs/OVERVIEW.md similarity index 100% rename from doc/OVERVIEW.md rename to docs/OVERVIEW.md diff --git a/doc/Screenshot1.png b/docs/Screenshot1.png similarity index 100% rename from doc/Screenshot1.png rename to docs/Screenshot1.png diff --git a/doc/Screenshot2.png b/docs/Screenshot2.png similarity index 100% rename from doc/Screenshot2.png rename to docs/Screenshot2.png diff --git a/src/Makefile.cardinal.mk b/src/Makefile.cardinal.mk index 980c7f7..126693e 100644 --- a/src/Makefile.cardinal.mk +++ b/src/Makefile.cardinal.mk @@ -306,8 +306,8 @@ $(TARGET_DIR)/$(NAME).lv2/mod%: ../MOD/$(NAME).lv2/mod% -@mkdir -p "$(shell dirname $@)" $(SILENT)ln -sf $(abspath $<) $@ -$(TARGET_DIR)/$(NAME).lv2/modgui/documentation.pdf: ../../doc/MODDEVICES.md $(TARGET_DIR)/$(NAME).lv2/modgui - (cd ../../doc/ && pandoc MODDEVICES.md -f markdown+implicit_figures -o $(abspath $@)) +$(TARGET_DIR)/$(NAME).lv2/modgui/documentation.pdf: ../../docs/MODDEVICES.md $(TARGET_DIR)/$(NAME).lv2/modgui + (cd ../../docs/ && pandoc MODDEVICES.md -f markdown+implicit_figures -o $(abspath $@)) endif $(TARGET_DIR)/$(NAME).vst/resources/%: ../Rack/res/%