Reorganize README
Signed-off-by: falkTX <falktx@falktx.com>
This commit is contained in:
falkTX
parent
72f42baac7
commit
e68b175101
86
README.md
86
README.md
|
|
@ -22,6 +22,40 @@ All VCV branding has been removed (to the best of our knowledge) in order to avo
|
|||
The VST3 version is in progress, already part of the build but still experimental.
|
||||
|
||||
|
||||
## Current status
|
||||
|
||||
With the exception of a few bugs, Cardinal can be considered stable.
|
||||
Though currently the following should be noted:
|
||||
|
||||
- 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)
|
||||
- Windows 32bit builds do not work well [#80](https://github.com/DISTRHO/Cardinal/issues/80)
|
||||
- Windows High-DPI issues [#186](https://github.com/DISTRHO/Cardinal/issues/186)
|
||||
|
||||
### Stable release
|
||||
|
||||
Cardinal releases have official builds for Linux, macOS and Windows.
|
||||
You can find these under https://github.com/DISTRHO/Cardinal/releases.
|
||||
|
||||
There are Linux builds for various architectures (armhf, arm64, i686 and x86_64), macOS "universal" (arm64 + intel) and Windows 32 and 64bit builds.
|
||||
Both macOS and Windows builds have an installer.
|
||||
Install instructions are available [here](https://github.com/DISTRHO/Cardinal/wiki/Install).
|
||||
|
||||
Note: Neither the macOS or Windows builds are signed, so expect warnings saying they are from an "untrusted developer".
|
||||
|
||||
### Nightly builds
|
||||
|
||||
You can find builds for pretty much any recent Cardinal commit [here](https://github.com/DISTRHO/Cardinal/actions/workflows/build.yml).
|
||||
Just click on any successful build, and scroll to the bottom to find the builds.
|
||||
(note the canvas-like area in the middle prevents mouse wheel scrolling)
|
||||
|
||||
A GitHub account is required in order to download these builds.
|
||||
|
||||
### Building
|
||||
|
||||
Basic building instructions are available in [BUILDING.md](docs/BUILDING.md).
|
||||
|
||||
|
||||
## Plugin variants
|
||||
|
||||
Cardinal provides 3 plugin variants - "main", Synth and FX.
|
||||
|
|
@ -70,46 +104,6 @@ But a couple of modules background's have their colors flipped, because damn we
|
|||
|
||||
|
||||
|
||||
## Current status
|
||||
|
||||
With the exception of a few bugs, Cardinal can be considered stable.
|
||||
Though currently the following should be noted:
|
||||
|
||||
- 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)
|
||||
- Windows 32bit builds do not work well [#80](https://github.com/DISTRHO/Cardinal/issues/80)
|
||||
|
||||
### Stable release
|
||||
|
||||
Cardinal releases have official builds for Linux, macOS and Windows.
|
||||
You can find these under https://github.com/DISTRHO/Cardinal/releases.
|
||||
|
||||
There are Linux builds for various architectures (armhf, arm64, i686 and x86_64), macOS "universal" (arm64 + intel) and Windows 32 and 64bit builds.
|
||||
Both macOS and Windows builds have an installer.
|
||||
Install instructions are available [here](https://github.com/DISTRHO/Cardinal/wiki/Install).
|
||||
|
||||
Note: Neither the macOS or Windows builds are signed, so expect warnings saying they are from an "untrusted developer".
|
||||
|
||||
### Nightly builds
|
||||
|
||||
You can find builds for pretty much any recent Cardinal commit [here](https://github.com/DISTRHO/Cardinal/actions/workflows/build.yml).
|
||||
Just click on any successful build, and scroll to the bottom to find the builds.
|
||||
(note the canvas-like area in the middle prevents mouse wheel scrolling)
|
||||
|
||||
A GitHub account is required in order to download these builds.
|
||||
|
||||
### Community chat
|
||||
|
||||
Currently we are all on #cardinal IRC room in irc.libera.chat server.
|
||||
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](docs/LICENSES.md#code-license--binary).
|
||||
|
||||
|
||||
## Included modules
|
||||
|
||||
At the moment the following 3rd-party modules are provided:
|
||||
|
|
@ -241,3 +235,15 @@ Cardinal and Rack should be able to co-exist friendly and peacefully, as they cl
|
|||
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](docs/DIFFERENCES.md).
|
||||
|
||||
|
||||
## 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](docs/LICENSES.md#code-license--binary).
|
||||
|
||||
|
||||
## Community chat
|
||||
|
||||
Currently we are all on #cardinal IRC room in irc.libera.chat server.
|
||||
Come join us in your favorite IRC client or through a Matrix bridge.
|
||||
|
|
|
|||
Loading…
Reference in New Issue