Skip to content

Commit

Permalink
docs: adapt docs to rename of faustpp to faustdoctor
Browse files Browse the repository at this point in the history
Signed-off-by: Christopher Arndt <[email protected]>
  • Loading branch information
SpotlightKid committed Nov 22, 2024
1 parent ce76339 commit 64b533f
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
6 changes: 3 additions & 3 deletions LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ PERFORMANCE OF THIS SOFTWARE.
DPF is released under the ISC license. Copyright 2012-2022 Filipe Coelho.


## faustpp
## faustdoctor

faustpp is released under the Boost Software License 1.0. Copyright 2022 Jean
Pierre Cimalando.
faustdoctor is released under the Boost Software License 1.0. Copyright 2022
Jean Pierre Cimalando, 2024 Christopher Arndt,


## For the CLAP format
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,15 +97,15 @@ variables differ depending on the target OS.*

* [pkgconf]

* The [faustpp] pre-processor and [FAUST] (optional)
* The [faustdoctor] pre-processor and [FAUST] (optional)

The [CLAP], [LV2], [LADSPA], [VST2][vst] (Xaymar VST2SDK) and [VST3][vst]
headers are included in the [DPF] framework, which is integrated as a Git
sub-module. These need not be installed separately to build the software in
the respective plugin formats.

`faustpp` and FAUST are only needed to re-generate C++ source and header files
if the FAUST DSP source files in the `faust` directory are changed.
`faustdoctor` and FAUST are only needed to re-generate C++ source and header
files if the FAUST DSP source files in the `faust` directory are changed.


## Author
Expand All @@ -121,7 +121,7 @@ This plugin is released under the *MIT* license. Please see the

## Acknowledgements

The DSP code is generated from the FAUST sources via the [faustpp]
The DSP code is generated from the FAUST sources via the [faustdoctor]
pre-processor.

The project is built using the DISTRHO Plugin Framework ([DPF]) and was created
Expand All @@ -134,7 +134,7 @@ from the [dpf-faust-project-template] using [copier].
[copier]: https://copier.readthedocs.io/en/stable/
[dpf]: https://github.com/DISTRHO/DPF
[faust]: https://faust.grame.fr/
[faustpp]: https://github.com/SpotlightKid/faustpp
[faustdoctor]: https://github.com/SpotlightKid/faustdoctor
[ladspa]: https://www.ladspa.org/
[lv2]: https://lv2plug.in/
[pkgconf]: https://github.com/pkgconf/pkgconf
Expand Down
6 changes: 3 additions & 3 deletions faust/arch/LICENSE-EXCEPTION.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# License exception

The architecture files under the `architectures/` directory are distributed
under BSL-1.0 license, like the software itself.
The architecture files under the `faustdoctor/architectures/` directory are
distributed under BSL-1.0 license, like the software itself.

The following license exception applies:

Is it not required to license, even partially, the code generated by `faustpp`
Is it not required to license, even partially, the code generated by `faustdr`
using these architecture files under the BSL-1.0 to cover the code fragments,
which are produced from the templates. It is allowed to retain in full the
license which applies to the Faust source file which is processed.

0 comments on commit 64b533f

Please sign in to comment.