mirror of
https://invent.kde.org/multimedia/kdenlive
synced 2025-12-05 15:59:59 +01:00
docs: update README
I'd like to propose some changes to the README: After brief welcome and introduction what this project is I would like to point regular users to the website. It contains the best and most up-to-date info for everything except dev/coding documentation. Everything after that would then focus only on developers / potential code contributors. I imagine the README to be the landing page we forward people to from the website that are interested in contributing code / hacking on the project. (On the new website this would be from the contribute page https://invent.kde.org/websites/kdenlive-org/-/merge_requests/22)
This commit is contained in:
balooii balooii
committed by
Jean-Baptiste Mardelle
Jean-Baptiste Mardelle
parent
72009eb4e7
commit
37037a2924
67
README.md
67
README.md
@@ -1,43 +1,50 @@
|
|||||||
|
|
||||||
|
|
||||||
# About Kdenlive
|
# Kdenlive
|
||||||
|
|
||||||
[Kdenlive](https://kdenlive.org) is a Free and Open Source video editing application, based on MLT Framework and KDE Frameworks 6. It is distributed under the [GNU General Public License Version 3](https://www.gnu.org/licenses/gpl-3.0.en.html) or any later version that is accepted by the KDE project.
|
Kdenlive is a powerful, free and open-source video editor that brings professional-grade video editing capabilities to everyone. Whether you're creating a simple family video or working on a complex project, Kdenlive provides the tools you need to bring your vision to life.
|
||||||
|
|
||||||
# Building from source
|
For more information about Kdenlive's features, tutorials, and community, please visit our [official website](https://kdenlive.org).
|
||||||
|
|
||||||
[Instructions to build Kdenlive](dev-docs/build.md) are available in the dev-docs folder.
|
There you can also find downloads for both stable releases and experimental daily builds for Kdenlive.
|
||||||
|
|
||||||
# Testing Kdenlive via Nightly Builds
|
## Contributing to Kdenlive
|
||||||
|
|
||||||
- AppImage (Linux): https://cdn.kde.org/ci-builds/multimedia/kdenlive/master/linux/
|
Kdenlive is a community-driven project, and we welcome contributions from everyone! There are many ways to contribute beyond coding:
|
||||||
- Flatpak (Linux):
|
|
||||||
- Add the kde flatpak repository (if not already done) by typing `flatpak remote-add --if-not-exists kdeapps --from https://distribute.kde.org/kdeapps.flatpakrepo` on a command line. (This step may be optional in your version of Flatpak.)
|
|
||||||
- Install kdenlive nightly with `flatpak install kdeapps org.kde.kdenlive`.
|
|
||||||
- Use `flatpak update` to update if the nightly is already installed.
|
|
||||||
- _Attention! If you use the stable kdenlive flatpak already, the `*.desktop` file (e.g. responsible for start menu entry) is maybe replaced by the nightly (and vice versa). You can still run the stable version with `flatpak run org.kde.kdenlive/x86_64/stable` and the nightly with `flatpak run org.kde.kdenlive/x86_64/master` (replace `x86_64` by `aarch64` or `arm` depending on your system)_
|
|
||||||
- Windows: https://cdn.kde.org/ci-builds/multimedia/kdenlive/master/windows/
|
|
||||||
- macOS x86: https://cdn.kde.org/ci-builds/multimedia/kdenlive/master/macos-x86_64/
|
|
||||||
- macOS ARM: https://cdn.kde.org/ci-builds/multimedia/kdenlive/master/macos-arm64/
|
|
||||||
|
|
||||||
*Note * - nightly/daily builds are not meant to be used in production.*
|
- Help translate Kdenlive into your language
|
||||||
|
- Report and triage bugs
|
||||||
|
- Write documentation
|
||||||
|
- Create tutorials
|
||||||
|
- Help other users on forums and bug trackers
|
||||||
|
|
||||||
# Contributing to Kdenlive
|
Visit [kdenlive.org](https://kdenlive.org) to learn more about non-code contributions.
|
||||||
|
|
||||||
Please note that Kdenlive's Github repo is just a mirror: read [this explanation for more details](https://community.kde.org/Infrastructure/Github_Mirror).
|
## Developer Information
|
||||||
|
|
||||||
The prefered way of submitting patches is a merge request on the [KDE GitLab on invent.kde.org](https://invent.kde.org/-/ide/project/multimedia/kdenlive): if you are not familar with the process there is a [step by step instruction on how to submit a merge reqest in KDE context](https://community.kde.org/Infrastructure/GitLab#Submitting_a_Merge_Request).
|
### Technology Stack
|
||||||
|
|
||||||
We welcome all feedback and offers for help!
|
Kdenlive is written in C++ and is using these technologies and frameworks:
|
||||||
|
|
||||||
* Talk about us!
|
- **Core Framework**: MLT for video editing functionality
|
||||||
* [Report bugs](https://kdenlive.org/en/bug-reports/) you encounter (if not already done)
|
- **GUI Framework**: Qt and KDE Frameworks 6
|
||||||
* Help other users [on the forum](http://forum.kde.org/viewforum.php?f=262) and bug tracker
|
- **Additional Libraries**: frei0r (video effects), LADSPA (audio effects)
|
||||||
* [Help to fill the manual](https://community.kde.org/Kdenlive/Workgroup/Documentation)
|
|
||||||
* Complete and check [application and documentation translation](http://l10n.kde.org)
|
### Getting Started
|
||||||
* Prepare video tutorials (intro, special tricks...) in your language
|
|
||||||
and send us a link to add in homepage or doc
|
1. Check out our [build instructions](dev-docs/build.md) to set up your development environment
|
||||||
* Detail improvement suggestions
|
2. Familiarize yourself with the [architecture](dev-docs/architecture.md) and [coding guidelines](dev-docs/coding.md)
|
||||||
we don't test every (any?) other video editor, so give precise explanations
|
4. If the MLT library is new to you check out [MLT Introduction](dev-docs/mlt-intro.md)
|
||||||
* Code! Help fixing bugs, improving usability, optimizing, porting...
|
3. Join our Matrix channel `#kdenlive-dev:kde.org` for developer discussions and support
|
||||||
register on KDE infrastructure, study its guidelines, and pick from roadmap. See [here](dev-docs/contributing.md) for more information
|
|
||||||
|
### Contributing Code
|
||||||
|
|
||||||
|
Kdenlive's primary development happens on [KDE Invent](https://invent.kde.org/multimedia/kdenlive). While we maintain a GitHub mirror, all code contributions should be submitted through KDE's GitLab instance. For more information about KDE's development infrastructure, visit the [KDE GitLab documentation](https://community.kde.org/Infrastructure/GitLab).
|
||||||
|
|
||||||
|
### Finding Things to Work On
|
||||||
|
|
||||||
|
- Browse open issues on [KDE Invent](https://invent.kde.org/multimedia/kdenlive/-/issues)
|
||||||
|
- Check the [KDE Bug Tracker](https://bugs.kde.org) for reported issues
|
||||||
|
- Look for issues tagged with "good first issue" or "help wanted"
|
||||||
|
|
||||||
|
Need help getting started? Join our Matrix channel `#kdenlive-dev:kde.org` - our community is friendly and always ready to help new contributors!
|
||||||
|
|||||||
@@ -1,4 +0,0 @@
|
|||||||
# Kdenlive Developer Docs
|
|
||||||
|
|
||||||
* Overview what these docs are
|
|
||||||
* Where to find more documentation (e.g. on MLT)
|
|
||||||
Reference in New Issue
Block a user