Linting MD files and review

AUTHORS.md

@@ -1,5 +1,6 @@
-Mainteiner(s)
+# Authors
-=============
+
+## Mainteiner(s)
 
 These people were/are mainteiners of this project.
 
@@ -12,9 +13,7 @@ These people were/are mainteiners of this project.
     <daniel.pizetta@usp.br> -
     improvements and bug fixes.
 
-
+## Contributor(s)
-Contributor(s)
-==============
 
 These people contribute to bug fixes, improvements and so on.
 Please, insert your information after the last one.

CHANGES.md

@@ -1,94 +1,96 @@
-Changelog
+# Changelog
-=========
 
-* 2.5.1:
+- 2.5.1:
-    - Fix travis files, needs more improvement #74
+  - Fix travis files, needs more improvement #74
-    - Improve modules description
+  - Improve modules description
-    - Update setup.py, remove license
+  - Update setup.py, remove license
-    - Improve README, CHANGES and AUTHORS
+  - Improve README, CHANGES and AUTHORS
-* 2.5:
+- 2.5:
-    - Add new complete example with new files
+  - Add new complete example with new files
-    - Add new screenshots for new example
+  - Add new screenshots for new example
-    - Update travis files
+  - Update travis files
-    - Add support to example of QtPy and PyQtGraph
+  - Add support to example of QtPy and PyQtGraph
-    - Move scripts for compiling to scrip folder
+  - Move scripts for compiling to scrip folder
-    - Update README, CHANGES
+  - Update README, CHANGES
-* 2.4:
+- 2.4:
-    - Add function to get Qt information from environment variable #69, #70, #73
+  - Add function to get Qt information from environment variable #69, #70, #73
-    - Add CC-BY license for images and transfer COPYING to LICENSE file #68
+  - Add CC-BY license for images and transfer COPYING to LICENSE file #68
-    - Fix tabs style - selected tab color and shift #59, #72
+  - Fix tabs style - selected tab color and shift #59, #72
-    - Restructure README creating AUTHORS, CHANGES, and LICENSE #71
+  - Restructure README creating AUTHORS, CHANGES, and LICENSE #71
-* 2.3.1:
+- 2.3.1:
-    - Improve checkbox color (use accent color used in other widgets) and darken view hover/selected colors to play nicer with other widget colors
+  - Improve checkbox color (use accent color used in other widgets) and
-    - Shift to the right the first tab
+    darken view hover/selected colors to play  nicer with other widget colors
-    - Update license year
+  - Shift to the right the first tab
-    - Update README (fix snapshots links and formatting)
+  - Update license year
-    - Removed QLineEdit top/bottom padding which cut off text while editing QListView items
+  - Update README (fix snapshots links and formatting)
-* 2.3.0:
+  - Removed QLineEdit top/bottom padding which cut off text while editing
-    - Add support for QDateEdit
+    QListView items
-* 2.2.2:
+- 2.3.0:
-    - Add hover to unselected item in QListView/QTreeView
+  - Add support for QDateEdit
-    - Fixes for vertical QToolBar, QToolBar Extend Button & QTabWidget's Pane Misalignment
+- 2.2.2:
-    - Fixed consistency of QTabBar depending on position
+  - Add hover to unselected item in QListView/QTreeView
-* 2.2.1:
+  - Fixes for vertical QToolBar, QToolBar Extend Button & QTabWidget's
-    - Remove border of status bar widgets
+    Pane Misalignment
-* 2.2:
+  - Fixed consistency of QTabBar depending on position
-    - Major update of the color scheme based on the Breeze Dark theme of KDE 5
+- 2.2.1:
-    - Fix issues #29, #30, #31, #32 and #35
+  - Remove border of status bar widgets
-* 2.1:
+- 2.2:
-    - Add style for QPushButton:checked
+  - Major update of the color scheme based on the Breeze Dark theme of KDE 5
-    - Improve QCheckBox and QRadioButton style
+  - Fix issues #29, #30, #31, #32 and #35
-    - Add style for QMenu::right-arrow
+- 2.1:
-* 2.0:
+  - Add style for QPushButton:checked
-    - Improve stylesheet to make it look a bit more modern (see pull request #25)
+  - Improve QCheckBox and QRadioButton style
-* 1.16:
+  - Add style for QMenu::right-arrow
-    - Fix QGroupBox title padding (see issue #20)
+- 2.0:
-* 1.15:
+  - Improve stylesheet to make it look a bit more modern (see pull request #25)
-    - Improve tristate checkbox graphics: undetermined state is now represented by a dash
+- 1.16:
-* 1.14:
+  - Fix QGroupBox title padding (see issue #20)
-    - Add support for tristate check boxes and for vertical and horizontal lines
+- 1.15:
-* 1.13:
+  - Improve tristate checkbox graphics: undetermined state is now represented by a dash
-    - Fix issue with horizontal scrollbar arrows, left and right were inversed.
+- 1.14:
-* 1.12:
+  - Add support for tristate check boxes and for vertical and horizontal lines
-    - Fix minimum size of input widgets (see issue #14)
+- 1.13:
-* 1.11:
+  - Fix issue with horizontal scrollbar arrows, left and right were inversed.
-    - Fix QDockWidget title position on Mac.
+- 1.12:
-    - Add QStatusBar support
+  - Fix minimum size of input widgets (see issue #14)
-    - Improve QToolButton especially the MenuButtonPopup and InstantPopup modes
+- 1.11:
-* 1.10:
+  - Fix QDockWidget title position on Mac.
-    - Add PyQt5 support
+  - Add QStatusBar support
-    - Fix bug #12 (dock widget title not dark on OSX. Note that this reopens issue #8 for MAC users)
+  - Improve QToolButton especially the MenuButtonPopup and InstantPopup modes
-* 1.9:
+- 1.10:
-    - Improve QTabBar consistency and make selected tabs more distinctive
+  - Add PyQt5 support
-* 1.8:
+  - Fix bug #12 (dock widget title not dark on OSX. Note that this reopens issue #8 for MAC users)
-    - Add support for QToolBox
+- 1.9:
-    - Fix issue with grid line in QTableView if there is only ONE row/column
+  - Improve QTabBar consistency and make selected tabs more distinctive
-* 1.7:
+- 1.8:
-    - Fix appearance of bottom tab bars (invert gradient)
+  - Add support for QToolBox
-    - Improve QTableView: add grid line and fix section borders
+  - Fix issue with grid line in QTableView if there is only ONE row/column
-    - Fix bug #7: bug when resizing QTableView
+- 1.7:
-    - Fix bug #8: text elidation no working on QDockWidget
+  - Fix appearance of bottom tab bars (invert gradient)
-* 1.6:
+  - Improve QTableView: add grid line and fix section borders
-    - Improve QToolButton style
+  - Fix bug #7: bug when resizing QTableView
-    - Add support for InstantPopup and MenuButtonPopup
+  - Fix bug #8: text elidation no working on QDockWidget
-    - Improve QMenu style (better spacing with icons)
+- 1.6:
-    - Add \__version__ to python package.
+  - Improve QToolButton style
-* 1.5:
+  - Add support for InstantPopup and MenuButtonPopup
-    - Improve QTabBar style: now works with all tab bar positions (North, South, West and East)
+  - Improve QMenu style (better spacing with icons)
-    - Fix bug #6: hide QTabBar base to avoid stange lines at the base of the tab bar.
+  - Add \__version__ to python package.
-* 1.4:
+- 1.5:
-    - Add style.qss to qrc file, this fix issues with cx_freeze
+  - Improve QTabBar style: now works with all tab bar positions (North, South, West and East)
-* 1.3:
+  - Fix bug #6: hide QTabBar base to avoid stange lines at the base of the tab bar.
-    - Remove outline on button, checkbox and radio button
+- 1.4:
-    - Add support for closable tabs
+  - Add style.qss to qrc file, this fix issues with cx_freeze
-    - Better disabled buttons
+- 1.3:
-    - Fix QTextEdit background color to match the color of QPlainTextEdit and QLineEdit
+  - Remove outline on button, checkbox and radio button
-    - Better hover/selected states for QTreeView and QListView
+  - Add support for closable tabs
-    - Add QHeaderView support
+  - Better disabled buttons
-* 1.2:
+  - Fix QTextEdit background color to match the color of QPlainTextEdit and QLineEdit
-    - Improve QTableView support
+  - Better hover/selected states for QTreeView and QListView
-* 1.1:
+  - Add QHeaderView support
-    - Switch to MIT license
+- 1.2:
-    - Add python 3 support
+  - Improve QTableView support
-* 1.0:
+- 1.1:
-    - First public release (LGPL v2)
+  - Switch to MIT license
+  - Add python 3 support
+- 1.0:
+  - First public release (LGPL v2)

LICENSE.md

@@ -1,5 +1,6 @@
-The MIT License (MIT) - Code
+# License
-============================
+
+## The MIT License (MIT) - Code
 
 Copyright (c) 2013-2018 Colin Duquesnoy
 
@@ -21,9 +22,7 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 
-
+## Creative Commons Attribution International 4.0 - Images
-Creative Commons Attribution International 4.0 (CC BY 4.0) - Images
-===================================================================
 
 QDarkStyle (c) 2013-2018 Colin Duquesnoy
 
@@ -41,7 +40,7 @@ Creative Commons public licenses provide a standard set of terms and conditions
 
 By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions.
 
-### Section 1 – Definitions.
+### Section 1 – Definitions
 
 a. __Adapted Material__ means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image.
 
@@ -65,7 +64,7 @@ j. __Sui Generis Database Rights__ means rights other than copyright resulting f
 
 k. __You__ means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning.
 
-### Section 2 – Scope.
+### Section 2 – Scope
 
 a. ___License grant.___
 
@@ -97,7 +96,7 @@ b. ___Other rights.___
 
    3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties.
 
-### Section 3 – License Conditions.
+### Section 3 – License Conditions
 
 Your exercise of the Licensed Rights is expressly made subject to the following conditions.
 
@@ -127,7 +126,7 @@ a. ___Attribution.___
 
    4. If You Share Adapted Material You produce, the Adapter's License You apply must not prevent recipients of the Adapted Material from complying with this Public License.
 
-### Section 4 – Sui Generis Database Rights.
+### Section 4 – Sui Generis Database Rights
 
 Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material:
 
@@ -139,7 +138,7 @@ c. You must comply with the conditions in Section 3(a) if You Share all or a sub
 
 For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights.
 
-### Section 5 – Disclaimer of Warranties and Limitation of Liability.
+### Section 5 – Disclaimer of Warranties and Limitation of Liability
 
 a. __Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.__
 
@@ -147,7 +146,7 @@ b. __To the extent possible, in no event will the Licensor be liable to You on a
 
 c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability.
 
-### Section 6 – Term and Termination.
+### Section 6 – Term and Termination
 
 a. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically.
 
@@ -163,13 +162,13 @@ c. For the avoidance of doubt, the Licensor may also offer the Licensed Material
 
 d. Sections 1, 5, 6, 7, and 8 survive termination of this Public License.
 
-### Section 7 – Other Terms and Conditions.
+### Section 7 – Other Terms and Conditions
 
 a. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed.
 
 b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License.
 
-### Section 8 – Interpretation.
+### Section 8 – Interpretation
 
 a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License.
 

README.md

@@ -1,28 +1,24 @@
-QDarkStylesheet
+# QDarkStylesheet
-===============
 
 [![Build Status](https://travis-ci.org/ColinDuquesnoy/QDarkStyleSheet.png?branch=master)](https://travis-ci.org/ColinDuquesnoy/QDarkStyleSheet)
-[![Number of PyPI downloads](https://img.shields.io/pypi/dm/QDarkStyle.svg)](https://pypi.python.org/pypi/QDarkStyle)
 [![Latest PyPI version](https://img.shields.io/pypi/v/QDarkStyle.svg)](https://pypi.python.org/pypi/QDarkStyle)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![License: CC BY 4.0](https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg)](https://creativecommons.org/licenses/by/4.0/)
 
 A dark stylesheet for Qt applications (Qt4, Qt5, PySide, PyQt4, PyQt5, QtPy,
 PyQtGraph).
 
+## Installation
 
-Installation
+### Python
-============
 
-
+From PyPI: Get the lastest stable version of ``qdarkstyle`` package
-Python
+using *pip* (preferable):
-------
-
-From PyPI: Get the lastest stable version of ``qdarkstyle`` package using *pip* (preferable):
 
 ```bash
 pip install qdarkstyle
 ```
 
-
 From code: Download/clone the project, go to ``qdarkstyle`` folder then:
 
 - You can use the *setup* script and pip install.
@@ -35,41 +31,35 @@ From code: Download/clone the project, go to ``qdarkstyle`` folder then:
     python setup.py install
     ```
 
+### C++
 
-C++
+- Download/clone the project and copy the following files to your application
----
+  directory (keep the existing directory hierarchy):
 
-1) Download/clone the project and copy the following files to your application
+  - **qdarkstyle/style.qss**
-directory (keep the existing directory hierarchy):
+  - **qdarkstyle/style.qrc**
+  - **qdarkstyle/rc/** (the whole directory)
 
-    - **qdarkstyle/style.qss**
+- Add **qdarkstyle/style.qrc** to your **.pro file**
-    - **qdarkstyle/style.qrc**
-    - **qdarkstyle/rc/** (the whole directory)
 
-2) Add **qdarkstyle/style.qrc** to your **.pro file**
+- Load the stylesheet:
 
-3) Load the stylesheet:
+  ```cpp
+  QFile f(":qdarkstyle/style.qss");
+  if (!f.exists())
+  {
+      printf("Unable to set stylesheet, file not found\n");
+  }
+  else
+  {
+      f.open(QFile::ReadOnly | QFile::Text);
+      QTextStream ts(&f);
+      qApp->setStyleSheet(ts.readAll());
+  ```
 
-    ```cpp
+## Usage
-    QFile f(":qdarkstyle/style.qss");
-    if (!f.exists())
-    {
-        printf("Unable to set stylesheet, file not found\n");
-    }
-    else
-    {
-        f.open(QFile::ReadOnly | QFile::Text);
-        QTextStream ts(&f);
-        qApp->setStyleSheet(ts.readAll());
-    }
 
-    ```
+Here is an example using PySide
-
-
-Usage
-=====
-
-Here is an example using PySide:
 
 ```Python
 import sys
@@ -91,7 +81,7 @@ app.exec_()
 To use another wrapper for Qt, you just need to replace some lines.
 See examples bellow.
 
-To use PyQt4, change two lines:
+To use PyQt4, change two lines
 
 ```Python
 from PySide import QtGui
@@ -119,10 +109,9 @@ app.exec_()
 ```
 
 If your project uses QtPy or you need to set it programmatically,
-it is far more simple:
+it is far more simple
 
 ```Python
-
 import sys
 import qdarkstyle
 import os
@@ -148,7 +137,7 @@ window.show()
 app.exec_()
 ```
 
-It is also simple if you use PyQtGraph:
+It is also simple if you use PyQtGraph
 
 ```Python
 import sys
@@ -157,7 +146,7 @@ import os
 
 # set the environment variable to use a specific wrapper
 # it can be set to PyQt, PyQt5, PySide or PySide2 (not implemented yet)
-os.environ['PYQTGRAPH_QT_LIB'] = 'PyQt' 
+os.environ['PYQTGRAPH_QT_LIB'] = 'PyQt'
 
 # import from pyqtgraph instead of doing it directly
 # note that PyQtGraph always uses PyQt4 API
@@ -179,14 +168,11 @@ _There is an example included in the *example* folder.
 You can run the script without installing qdarkstyle. You only need to have
 PySide (or PyQt4 or PyQt5) installed on your system._
 
-
+## Snapshots
-Snapshots
-=========
 
 Here are a few snapshots comparing the use of QDarkStyle and the default style.
 Click in the image to zoom.
 
-
 <table style="width:100%">
   <tr>
     <th colspan=2>Containers (no tabs) and Buttons</th>
@@ -218,30 +204,22 @@ Click in the image to zoom.
   </tr>
 </table>
 
-
+## Changelog
-Changelog
-=========
 
 Please, see [CHANGES](CHANGES.md) file.
 
-
+## License
-License
-=======
 
 This project is licensed under the MIT license.
 Imagens contained in this project are licensed under CC-BY license.
 
 For more information see [LICENSE](LICENSE.md) file.
 
-
+## Authors
-Authors
-=======
 
 For more information see [AUTHORS](AUTHORS.md) file.
 
-
+## Contribute
-Contribute
-==========
 
 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