Home

Awesome

<!-- SPDX-FileCopyrightText: 2023-2024 Mirian Margiani SPDX-License-Identifier: GFDL-1.3-or-later -->

Template for new Opal modules

Copy this repository to setup a new Opal module.

  1. Create a local copy of the contents of this repository.
  2. Run setup.sh and follow the instructions.
  3. Import your source code to Opal/MyModule/ and write documentation.
  4. Add an example to README.md.
  5. Update release-module.sh: if your module has no translations, set cTRANSLATE=(Opal) to cTRANSLATE=()
  6. Remove this introduction from README.md.
  7. Add screenshots to doc/ and update README.md accordingly.
  8. Run ./release-module.sh to build docs and create a release bundle.
<hr>

MyModule

Brief description of the module.

Longer description of which problem the module solves, and how it makes life easier.

Usage

import QtQuick 2.0
import Sailfish.Silica 1.0
import Opal.MyModule 1.0

MyComponent {
    // ...
}

Screenshots

Screenshots can be found in the doc directory.

<!-- | 1. | 2. | |-|-| | <img src="./doc/screenshot-01.webp" width="600" /> | <img src="./doc/screenshot-02.webp" width="600" /> | | 1. | 2. | 3. | |-|-|-| | <img src="./doc/screenshot-01.webp" width="600" /> | <img src="./doc/screenshot-02.webp" width="600" /> | <img src="./doc/screenshot-03.webp" width="600" /> | -->

How to use

You do not need to clone this repository if you only intend to use the module in another project. Simply download the latest release bundle from the "Releases" page.

Setup

Follow the main documentation for installing Opal modules here.

Configuration

See doc/gallery.qml for an example. Read the file to get started.

Documentation

Documentation is included in the release bundle and can be added to QtCreator via Extras → Settings → Help → Documentation → Add.

Translations

To use packaged translations in your project, follow the main documentation for using Opal modules here.

You can also contribute translations. If an app uses Opal modules, consider updating its translations at the source (i.e. here), so that all Opal users can benefit from it. Translations are managed using Weblate.

Please prefer Weblate over pull requests (which are still welcome, of course). If you just found a minor problem, you can also leave a comment in the forum or open an issue.

Please include the following details:

  1. the language you were using
  2. where you found the error
  3. the incorrect text
  4. the correct translation

See the Qt documentation for details on how to translate date formats to your local format.

License

Copyright (C)  Mirian Margiani
Program: opal-mymodule

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.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.