w4kek/WSJT-X
1
0
Fork 0
mirror of https://github.com/saitohirga/WSJT-X.git synced 2024-11-18 10:01:57 -05:00
Code Issues Packages Projects Releases Wiki Activity

Fix and add new information

Browse Source
This commit is contained in:
Daniel Pizetta 2018-02-20 17:01:58 -03:00
parent de11028293
commit 96590ea2d3
2 changed files with 33 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
CONTRIBUTE.md
View File

@ -119,11 +119,11 @@ These are the basic steps needed to start developing on QDarkStyle.
Inside modules we provided a logging that should be used to inform the user. Inside modules we provided a logging that should be used to inform the user.
Please, follow the levels bellow. Please, follow the levels bellow.
- debug: for debug information, high detailed one, directed to programers; - debug: for debug information, high detailed one, directed to programers
- info: something important for common user to know; - info: something important for common user to know
- warning: something that should not be a big problem or a desicision changed; - warning: something that should not be a big problem or a desicision changed
- error: some error, but not capable of stop program; - error: some error, but not capable of stop program
- critical: something that stops the running program. - critical: something that stops the running program
## Guide to QDarkStyle ## Guide to QDarkStyle
@ -133,22 +133,23 @@ widget provided by Qt - common ones. Feel free to add more to them.
To simplify the structure, there are separated files in To simplify the structure, there are separated files in
[example.ui](.example/ui/) folder. [example.ui](.example/ui/) folder.
- `dw_buttons.ui`: all types of buttons; - `dw_buttons.ui`: all types of buttons
- `dw_containers_no_tabs.ui`: all types of containers except for tabs; - `dw_containers_no_tabs.ui`: all types of containers except for tabs
- `dw_containers_tabs.ui`: all containers tabs; - `dw_containers_tabs.ui`: all containers tabs
- `dw_displays.ui`: all types of displays; - `dw_displays.ui`: all types of displays
- `dw_inputs_fields.ui`: all types of inputs with fields; - `dw_inputs_fields.ui`: all types of inputs with fields
- `dw_inputs_no_fields.ui`: all types of inputs without fields; - `dw_inputs_no_fields.ui`: all types of inputs without fields
- `dw_views.ui`: all types of views; - `dw_views.ui`: all types of views
- `dw_widgets.ui`: all types of widgets; - `dw_widgets.ui`: all types of widgets
- `mw_menus.ui`: main window with all menus and toolbars. - `mw_menus.ui`: main window with all menus and toolbars
*Obs.: `dw` stands for dock widget and `mw` for main window.* *Obs.: `dw` stands for dock widget and `mw` for main window.*
The entire example is built at runtime, in The entire example is built at runtime, in
[example.py](./example/example.py). [example.py](./example/example.py). To see more information about it,
see its documentation.
To see more information about it, see its documentation. ### Modifying UI Files
Feel free to modify `.ui` files with Qt Designer and recompile UI using Feel free to modify `.ui` files with Qt Designer and recompile UI using
[process_ui.py](./script/process_ui.py) script, inside script folder, using: [process_ui.py](./script/process_ui.py) script, inside script folder, using:
@ -159,9 +160,11 @@ python process_ui.py
It will generate all `_ui.py` files for PyQt4, PyQt5, PySide, QtPy, PyQtGraph. It will generate all `_ui.py` files for PyQt4, PyQt5, PySide, QtPy, PyQtGraph.
If you are changing the stylesheet, you will need to recompile the QRC ### Modifying QSS File
files using [process_qrc.py](./script/process_qrc.py) script, inside
script folder. If you are changing the [stylesheet](.qdarkstyle/style.qss) , you will need
to recompile the QRC files using [process_qrc.py](./script/process_qrc.py)
script, inside script folder.
```bash ```bash
python process_qrc.py python process_qrc.py
@ -169,6 +172,8 @@ python process_qrc.py
This generates all `_rc.py` files for PyQt4, PyQt5, PySide, QtPy, PyQtGraph. This generates all `_rc.py` files for PyQt4, PyQt5, PySide, QtPy, PyQtGraph.
### Making It Easy
To simplify this process for the developer, if you are changing many things, To simplify this process for the developer, if you are changing many things,
use the script [run_ui_css_edition.py](./script/run_ui_css_edition.py): use the script [run_ui_css_edition.py](./script/run_ui_css_edition.py):
@ -177,10 +182,9 @@ python run_ui_css_edition.py
``` ```
This creates a loop that restarts the application, process ui and css This creates a loop that restarts the application, process ui and css
files. For more information see its documentation. files.
For more information about those scripts and their options, see their For more information about those scripts, see their documentation.
documentation.
### Qt, Stylesheets and Palettes ### Qt, Stylesheets and Palettes
@ -209,3 +213,8 @@ for it. This will keep our implementation stable.
If you are fixing something about style, please, provide an screenshot If you are fixing something about style, please, provide an screenshot
before and after the fix to comparison. This could be inserted in the issue before and after the fix to comparison. This could be inserted in the issue
tracker, as a message. tracker, as a message.
## If You Are a Mantainer, Go Ahead
We create a guide to create and upload this package to PyPI, follow the
instructions in [PRODUCTION](.PRODUCTION.md).

2
README.md
View File

@ -224,3 +224,5 @@ For more information see [AUTHORS](AUTHORS.md) file.
Most widgets have been styled. If you find a widget that has not been Most widgets have been styled. If you find a widget that has not been
style, just open an issue on the issue tracker or, better, submit a pull style, just open an issue on the issue tracker or, better, submit a pull
request. request.
If you want to contribute, see how to [CONTRIBUTE](CONTRIBUTE.md).