Details
-
Task
-
Resolution: Fixed
-
P2: Important
-
None
-
None
-
None
-
80573dd36 (dev), 9e6717ed6 (6.6), f3b298353 (6.5)
-
DaVinci 83, DaVinci 84, DaVinci 85, DaVinci 86, DaVinci 87, DaVinci 88
Description
It is beneficial to have a standardize README.md file across Qt modules. At the moment, some README files may contain build information that might be outdated. If we can replace these files with a timeless template that we can use across all modules, we can avoid having outdated information, and instead provide links to official documentations when needed.
Looking between our modules, QtQuick3DPhysics has a relatively good readme file, which looks like this when turned into a template. I've edited the original file by adding a few other useful sections to it.
# Qt <Module> <!--- Breif description of the module, often the first paragraph of the <module>/src/…/doc/src/<module>.qdoc E.g., Qt Quick 3D Physics provides a high-level API for physics simulation. It supports simulating interactive rigid bodies as well as static meshes and non-colliding bodies used for detecting overlaps. Every simulated body can have its own physical properties like mass, density and friction. ---> ## Documentation <!--- Brief note on where to find the documentation. This can point to the online page, and also provide a brief instruction on how to find, and build the documentation of the module, maybe a link to the qdoc file. E.g., The Qt Quick 3D Physics documentation is available as a submodule of the Qt Framework’s documentation. You can find it in the Qt documentation [online](https://doc-snapshots.qt.io/qt6-dev/qtquick3dphysics-index.html), or you can build it locally from the source code by building the QtDoc module. In addition, you may access the human-readable .qdoc documentation files directly, located in `src/<module>/doc/src` directory. ---> ## Build <!--- Brief description fo the build process, e.g., Qt <Module> is part of Qt Framework, and it may depends on other modules. See [here](https://doc.qt.io/qt-6/build-sources.html) on how to build Qt framework, and its modules. If you are familiar with CMake, you may configure and build Qt <Module> by passing `-DQT_BUILD_MODULES=<module>` variable to the `cmake` command when configuring the Qt Framework, e.g., cd qt-everywhere-src-%VERSION% mkdir build; cd build cmake .. -DQT_BUILD_MODULES= -GNinja ninja ---> ## Reporting Issues <!--- How and where to report an issue, If you encounter any issues while using Qt Quick 3D Physics, you can report them on the [Qt bug tracker](https://bugreports.qt.io/). Before submitting a new issue, please check the existing issues to see if the issue has already been reported, and make sure to select the “Quick: 3D Physics” component when creating a new issue. ---> ## Contributing <!--- How to contribute We welcome contributions to Qt <Module>. If you are interested in contributing, please read the [Qt Contribution Guidelines](https://wiki.qt.io/Qt_Contribution_Guidelines) for more details. ---> ## License <!--- About licensing Qt Quick 3D Physics is available under the commercial license from The Qt Company. In addition, it is available under the [GNU General Public License, version 3](http://www.gnu.org/licenses/gpl-3.0.html). Further 3rd party Licenses and Attributions can be found in the LICENSES folder, as well as documented [here](https://doc-snapshots.qt.io/qt6-dev/qtquick3dphysics-index.html#license-and-attributions). --->
This is only a suggestion, and it should be evaluated and edited before we land on an acceptable, and expressive template.
Attachments
Issue Links
- relates to
-
QTBUG-89277 Document various aspects of how to build Qt 6 with CMake
- Reported
-
QTBUG-107754 Consider simplifying, or removing the `qtbase/cmake/README.md`
- Reported
-
QTBUG-116663 Add CONTRIBUTING file to repositories
- Closed