Skip to content

Commit

Permalink
Reorder information between the files
Browse files Browse the repository at this point in the history
  • Loading branch information
paulfd committed Jul 15, 2020
1 parent 92dd99b commit 2f2ea0b
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 19 deletions.
16 changes: 1 addition & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,24 +36,10 @@ 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.

### Financial contribution

Sfizz and the work in the SFZ tools organization is purely driven by hobbyists up to now, who chose and still choose to use their free time to benefit this project.
The core sfizz library and the plugins are available under permissive licenses to make them reusable within your own music projects or as components to build applications.
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, and as seen throughout this document there are many ways to contribute to the project.

In all of sfizz's governance model, we strive to live in the open as much as the project allows.
Finances are no different, and we put in place a process so that the use of donations is as transparent as possible.
We invite you to check out the [GOVERNANCE] file to see how the organization is governed and how are donations handled.

## Developing for sfizz

We welcome all code contributions to sfizz, whatever your coding level.
Expand Down Expand Up @@ -230,7 +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]: https://github.com/sfztools/sfizz/blob/develop/GOVERNANCE.md
[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
Expand Down
8 changes: 4 additions & 4 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ We wish to:
- 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 [Open Collective Europe].
The Open Collective Europe 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.
Considering these constraints, we chose to host the SFZ tools organization within the [Open-source 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:

Expand All @@ -37,7 +37,7 @@ The partition may also include other project that sfizz uses or wish to support.
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 5% 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.
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

Expand All @@ -47,4 +47,4 @@ It is the role of maintainers to best adapt the governance model to the evolutio
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 Collective Europe]: https://opencollective.com/europe
[Open-source Open Collective]: https://opencollective.com/opensource
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,30 @@ SFZ library and LV2 plugin, please check [our website] for more details.

![Screenshot](screenshot.png)

## 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:
Expand All @@ -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

0 comments on commit 2f2ea0b

Please sign in to comment.