Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rodlie committed Jun 16, 2024
1 parent 5f6cc25 commit 252ff9e
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

## Contribute

We accept any contributions (in form of a PR). Before submitting a PR it's recommended that you communicate with the developers first (in [issues](https://github.com/friction2d/friction/issues) or [discussions](https://github.com/friction2d/friction/discussions)). Someone might already be working on the same feature/issue, or for some reason the feature is not wanted.
We accept any contributions, big or small. Before submitting a PR it's recommended that you communicate with the developers first (in [issues](https://github.com/friction2d/friction/issues) or [discussions](https://github.com/friction2d/friction/discussions)).

It's always preferred to submit PR's against the `main` branch. If your feature is experimental, a new branch could be made available for further development before entering `main`.
It's always preferred to submit PR's against the `main` branch.

## Branches and versions

Expand All @@ -16,11 +16,11 @@ Friction uses `X.Y.Z` version numbers and `vX.Y` branches.
* `Y` = Minor
* `Z` = Patch

Branch `main` is always the current branch for the next `X` or `Y` release. The `main` branch should not be considered stable, but usable.
Branch `main` is always the current branch for the next `X` or `Y` release.

A new stable branch is cut from `main` on each `X` or `Y` release and is maintained until a new stable branch is created. The next `Z` (patch) release comes from the latest stable branch (`vX.Y`).
A new stable branch is cut from `main` on each `X` or `Y` release and is maintained until a new stable branch is created. Patch (`Z`) releases comes from the parent stable branch (`vX.Y`).

Bug and security fixes to `main` will be backported to active stable branches when possible (and within reason).
Critical fixes to `main` will be backported to active stable branches when possible (and within reason).

## Build

Expand All @@ -33,15 +33,15 @@ Generic build instructions.
* python3
* cmake *(3.12+)*
* clang *(7+)*
* Qt *(5.15)*
* Qt *(5.15.x)*
* Gui
* Widgets
* OpenGL
* Multimedia
* Qml
* Xml
* qscintilla
* ffmpeg *(4.2)*
* ffmpeg *(4.2.x)*
* libavformat
* libavcodec
* libavutil
Expand Down Expand Up @@ -125,7 +125,7 @@ cmake --build . --config Release

## License

Copyright © Friction [contributors](https://github.com/friction2d/friction/graphs/contributors).
Copyright © Friction contributors.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Expand Down

0 comments on commit 252ff9e

Please sign in to comment.