openprivacy
/
opaque
3
0
Fork 0
Code Issues 3 Pull Requests 1 Releases Wiki Activity

Update 'Readme.md'

This commit is contained in:
erinn 2020-05-20 14:05:11 -07:00
parent db305895e7
commit b1267659a1
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
Readme.md
View File

@ -1 +1,30 @@
# Opaque
Open Privacy's Awesome Qt-based User Experience Library!
## Usage
Add the Opaque widgets as a submodule wherever your QML files are stored:
```
cd qml
git submodule add https://git.openprivacy.ca/openprivacy/opaque.git
git submodule init
git submodule update
```
Compile as normal. :)
## Translations
Currently the EmojiDrawer is the only widget that needs translations, and it hasn't been fully ported into the translation system yet.
To use translations, install the appropriate `i18n/*` files as Qt translators. For example, in Cwtch we load translations as follows:
```
gcd.OpaqueTranslator = core.NewQTranslator(nil)
gcd.OpaqueTranslator.Load("translation_"+core.QLocale_System().Name(), ":/qml/opaque/i18n/", "", "")
core.QCoreApplication_InstallTranslator(gcd.OpaqueTranslator)
```
## Widgets
Documentation coming soon. :)