sam/sfizz
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source 
Added wiki link, OBS badge and some clean up
This commit is contained in:
redtide 2023-05-25 08:11:53 +02:00 • committed by GitHub
parent 76aa35a65f
commit f407ea8d64
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 46 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

82
README.md
View file

@ -1,6 +1,7 @@
# sfizz
![build](https://github.com/sfztools/sfizz/actions/workflows/build.yml/badge.svg)
[![build actions]](https://github.com/sfztools/sfizz/actions)
[![build obs]](https://build.opensuse.org/package/show/home:sfztools:sfizz:develop/sfizz)
[![Discord Badge Image]](https://discord.gg/3ArE9Mw)
[![SFZv1 Status Image]](https://sfz.tools/sfizz/development/status/opcodes/?v=1)
@ -9,7 +10,7 @@
[![Cakewalk Status Image]](https://sfz.tools/sfizz/development/status/opcodes/?v=cakewalk)
SFZ parser and synth c++ library and JACK standalone client,
please check [our website] for more details.
please check [our website] for more details, or [our wiki] for further information.
## Repository reorganization
@ -22,7 +23,7 @@ please check [our website] for more details.
[sfizz-ui]: https://github.com/sfztools/sfizz-ui
So if you are looking for plugins, you can get both by looking for the `sfizz-ui`
repository instead, which contains also this one in the `library` subdirectory.
repository instead, which contains also this one in the `library` subdirectory/git submodule.
## Using sfizz
@ -35,19 +36,24 @@ On any operating system, you might prefer to [build from source]!
## Contributing to sfizz
There is actually many things anyone can do, programming-related or music-related.
Please check out the [CONTRIBUTING] document for information about filing bug reports or feature requests, and helping the development of sfizz
Please check out the [CONTRIBUTING] document for information about filing bug reports or feature requests,
and helping the development of sfizz
## Donating to sfizz
Sfizz and the work in the SFZ tools organization is purely driven by hobbyists who choose to use their free time to benefit this project.
We firmly believe in the honesty and goodwill of users as a whole, and we want to promote a healthy relationship to software and to the cost of producing quality software.
Sfizz and the work in the SFZ tools organization is purely driven by hobbyists
who choose to use their free time to benefit this project.
We firmly believe in the honesty and goodwill of users as a whole,
and we want to promote a healthy relationship to software and to the cost of producing quality software.
No financial returns is explicitely required from using sfizz in any shape.
However, if you feel that sfizz produces value for you or your products, and if you find that your financial situation allows for it, we put together ways to donate to the project.
However, if you feel that sfizz produces value for you or your products,
and if you find that your financial situation allows for it, we put together ways to donate to the project.
You are never compelled to do so, the [CONTRIBUTING] file contains different ways to contribute.
In all of sfizz's governance model, we strive to live in the open.
Finances are no different, and we put in place a process so that the use of donations is as transparent as possible through our [Open Collective].
Finances are no different, and we put in place a process so that the use of donations
is as transparent as possible through our [Open Collective].
We invite you to check out the [GOVERNANCE] file to see how the organization is governed and how are donations handled.
## Dependencies and licenses
@ -69,7 +75,8 @@ The sfizz library makes primary use of:
- [pugixml] by Arseny Kapoulkine, licensed under the MIT license
- [cephes] by Stephen Moshier, licensed under the BSD 3-Clause license
- [cpuid] by Steinwurf ApS, licensed under the BSD 3-Clause license
- [faust-libraries] by GRAME, Julius O. Smith III and Eric Tarr, licensed under the STK-4.3 license and a permissive variant of the LGPL license
- [faust-libraries] by GRAME, Julius O. Smith III and Eric Tarr,
licensed under the STK-4.3 license and a permissive variant of the LGPL license
The sfizz library also uses in some subprojects:
@ -81,35 +88,38 @@ The sfizz library also uses in some subprojects:
- [libsamplerate], licensed under the BSD 2-Clause license
[CONTRIBUTING]: CONTRIBUTING.md
[GOVERNANCE]: GOVERNANCE.md
[Abseil]: https://abseil.io/
[atomic_queue]: https://github.com/max0x7ba/atomic_queue
[benchmark]: https://github.com/google/benchmark
[Catch2]: https://github.com/catchorg/Catch2
[filesystem]: https://github.com/gulrak/filesystem
[Surge tuning]: https://surge-synth-team.org/tuning-library/
[pugixml]: https://pugixml.org/
[cephes]: https://www.netlib.org/cephes/
[cpuid]: https://github.com/steinwurf/cpuid
[dr_libs]: https://github.com/mackron/dr_libs
[faust-libraries]: https://github.com/grame-cncm/faustlibraries
[hiir]: http://ldesoras.free.fr/prod.html#src_hiir
[KISS FFT]: http://kissfft.sourceforge.net/
[JACK]: https://github.com/jackaudio/jack2
[cxxopts]: https://github.com/jarro2783/cxxopts
[fmidi]: https://github.com/jpcima/fmidi
[libsamplerate]: http://www.mega-nerd.com/SRC/
[libsndfile]: http://www.mega-nerd.com/libsndfile/
[our website]: https://sfz.tools/sfizz
[releases]: https://github.com/sfztools/sfizz/releases
[Carla]: https://kx.studio/Applications:Carla
[Ardour]: https://ardour.org/
[API]: https://sfz.tools/sfizz/api/
[Open Collective]: https://opencollective.com/sfztools
[CONTRIBUTING]: CONTRIBUTING.md
[GOVERNANCE]: GOVERNANCE.md
[Abseil]: https://abseil.io/
[atomic_queue]: https://github.com/max0x7ba/atomic_queue/
[benchmark]: https://github.com/google/benchmark/
[Catch2]: https://github.com/catchorg/Catch2/
[filesystem]: https://github.com/gulrak/filesystem/
[Surge tuning]: https://surge-synth-team.org/tuning-library/
[pugixml]: https://pugixml.org/
[cephes]: https://www.netlib.org/cephes/
[cpuid]: https://github.com/steinwurf/cpuid/
[dr_libs]: https://github.com/mackron/dr_libs/
[faust-libraries]: https://github.com/grame-cncm/faustlibraries/
[hiir]: http://ldesoras.free.fr/prod.html#src_hiir
[KISS FFT]: http://kissfft.sourceforge.net/
[JACK]: https://github.com/jackaudio/jack2/
[cxxopts]: https://github.com/jarro2783/cxxopts/
[fmidi]: https://github.com/jpcima/fmidi/
[libsamplerate]: http://www.mega-nerd.com/SRC/
[libsndfile]: http://www.mega-nerd.com/libsndfile/
[our website]: https://sfz.tools/sfizz/
[our wiki]: https://sfz.tools/sfizz-wiki/
[releases]: https://github.com/sfztools/sfizz/releases/
[Carla]: https://kx.studio/Applications:Carla
[Ardour]: https://ardour.org/
[API]: https://sfz.tools/sfizz/api/
[Open Collective]: https://opencollective.com/sfztools
[build from source]: https://sfz.tools/sfizz/development/build/
[Discord Badge Image]: https://img.shields.io/discord/587748534321807416?label=discord&logo=discord
[OBS]: https://software.opensuse.org//download.html?project=home%3Asfztools%3Asfizz&package=sfizz
[build actions]: https://github.com/sfztools/sfizz/actions/workflows/build.yml/badge.svg?branch=develop
[build obs]: https://build.opensuse.org/projects/home:sfztools:sfizz:develop/packages/sfizz/badge.svg
[OBS]: https://software.opensuse.org//download.html?project=home%3Asfztools%3Asfizz&package=sfizz
[SFZv1 Status Image]: https://sfz.tools/assets/img/sfizz/badge_sfz1.svg
[SFZv2 Status Image]: https://sfz.tools/assets/img/sfizz/badge_sfz2.svg
[ARIA Status Image]: https://sfz.tools/assets/img/sfizz/badge_aria.svg