commit
b1ac0bfe9d
4 changed files with 82 additions and 1 deletions
|
|
@ -36,7 +36,6 @@ The project [sfizz-render] illustrates how one might use sfizz as a shared libra
|
|||
Other projects that bundle or use sfizz are:
|
||||
|
||||
- (https://github.com/sfztools/beatbox): a live drum machine
|
||||
-
|
||||
|
||||
If you use the library, maybe you will have specific needs and requests that could be useful to you.
|
||||
Be sure to post an issue for this so we can improve the API, especially because we have to queue API changes so it stays a bit stable over time.
|
||||
|
|
@ -217,6 +216,7 @@ The file `scripts/performance_report.py` is made to process and produce a nice i
|
|||
[build]: https://sfz.tools/sfizz/development/build/
|
||||
[benchmark]: https://github.com/google/benchmark
|
||||
[sfizz-render]: https://github.com/sfztools/sfizz-render
|
||||
[GOVERNANCE]: GOVERNANCE.md
|
||||
[api]: https://sfz.tools/sfizz/api/
|
||||
[RAII]: https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#S-resource
|
||||
[CppCoreGuidelines]: https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines
|
||||
|
|
|
|||
1
FUNDING.yml
Normal file
1
FUNDING.yml
Normal file
|
|
@ -0,0 +1 @@
|
|||
open_collective: sfztools
|
||||
50
GOVERNANCE.md
Normal file
50
GOVERNANCE.md
Normal file
|
|
@ -0,0 +1,50 @@
|
|||
## Leadership
|
||||
|
||||
The current maintainers of sfizz and the sfz tools organization are :
|
||||
|
||||
- Paul "@paulfd" Ferrand
|
||||
- Jean-Pierre "@jpcima" Cimalando
|
||||
- Andrea "@redtide" Zanellato
|
||||
|
||||
1. Sfizz does not follow a so-called "Benevolent Dictatorship for Life" model.
|
||||
Given the current size of the project, we believe an horizontal organization model to be the most relevant.
|
||||
2. Decisions regarding the technical part or the organizational part of the project are taken unanimously between the maintainers, where anyone can obviously abstain on any decision.
|
||||
3. We use Git as a global supporting platform for all decisions regarding the project, in the form of either pull requests or issues.
|
||||
This guarantees that a trace is kept for any contribution or change, and that users may interject and discuss on the subject at hand.
|
||||
|
||||
## Donations and financial contributions
|
||||
|
||||
In most jurisdictions, handling money requires bank accounts and identification as a physical person, or be incorporated as a non-profit or for-profit organization.
|
||||
We wish to:
|
||||
|
||||
- keep things simple;
|
||||
- support the horizontal governance model we chose;
|
||||
- facilitate a transparent handling of the finances of the project from the maintainers;
|
||||
- abide by international laws for the transfer and handling of money in support of a project.
|
||||
|
||||
Considering these constraints, we chose to host the SFZ tools organization within the [SFZTools Open Collective].
|
||||
The Open Collective fiscal host holds the money of unincorporated partnerships such as SFZ tools, providing legal channels and accounting, as well as tools to support a transparent budget management by members of the collective.
|
||||
|
||||
We apply the following ruleset to handle the project's financial resources:
|
||||
|
||||
1. As everything in SFZ tools, usage of the project's financial resources is subject to unanimous approval by all maintainers.
|
||||
2. The money is primarily directed towards expenses to support hosting the project---namely the website, and continuous testing and integration platforms.
|
||||
3. At any time, a maintainer may submit an expense request regarding the development of sfizz, for example but not limited to software resources, commercial SFZ libraries, or hardware devices.
|
||||
4. Every 3 months, during the months of March, June, September and December, the maintainers will gather in a budget meeting. The goal of the budget meeting decide in goodwill how to handle the money left over between contributors to the project.
|
||||
5. The partition should take into account individual technical and organizational contributions.
|
||||
The partition may also include other project that sfizz uses or wish to support.
|
||||
6. Any contributor may waive its own share to benefit either the project---pooling back resources for the next round---or the other contributors.
|
||||
7. Failure to reach a unanimous agreement will see the donations pooled back until the next budget meeting.
|
||||
8. The budget and expenses are kept public so all donators can keep track of how their donations are used.
|
||||
|
||||
Note that the Open Collective platform charges a 10% administrative fee on all donations; subsequent fees may be charged by credit card or banks as the money is moved from the collective to individual accounts.
|
||||
|
||||
## Changes to the governance model
|
||||
|
||||
1. This document is subject to changes and version control.
|
||||
It is the role of maintainers to best adapt the governance model to the evolution of the project.
|
||||
2. Change to the governance model are mapped to changes to this document through the same decision process, e.g. a pull request with approval from all maintainers.
|
||||
3. Maintainers can be invited from regular contributors at any point in time; maintainers wishing to leave the governance of the project may inform the other maintainers.
|
||||
In both cases, updates to this document reflect the evolution of the governance team and rules.
|
||||
|
||||
[Open-source Open Collective]: https://opencollective.com/sfztools
|
||||
30
README.md
30
README.md
|
|
@ -7,6 +7,30 @@ SFZ library and LV2 plugin, please check [our website] for more details.
|
|||
|
||||

|
||||
|
||||
## Using sfizz
|
||||
|
||||
Sfizz can be used most easily within an LV2 host such as [Carla] or [Ardour].
|
||||
It can also be integrated as a library within your own program; check out our [API] bindings for C and C++.
|
||||
Our [releases] are an immediate way to get a working library or LV2/VST plugin, although 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 (CONTRIBUTING.md) 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.
|
||||
|
||||
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.
|
||||
You are never compelled to do so, the (CONTRIBUTING.md) 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].
|
||||
We invite you to check out the (GOVERNANCE.md) file to see how the organization is governed and how are donations handled.
|
||||
|
||||
## Dependencies and licenses
|
||||
|
||||
The sfizz library makes primary use of:
|
||||
|
|
@ -32,5 +56,11 @@ The sfizz library also uses in some subprojects:
|
|||
[libsndfile]: https://github.com/erikd/libsndfile/
|
||||
[LV2]: https://lv2plug.in/
|
||||
[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
|
||||
[build from source]: https://sfz.tools/sfizz/development/build/
|
||||
[AppVeyor Build Status]: https://img.shields.io/appveyor/ci/sfztools/sfizz.svg?label=Windows&style=popout&logo=appveyor
|
||||
[Travis Build Status]: https://img.shields.io/travis/com/sfztools/sfizz.svg?label=Linux&style=popout&logo=travis
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue