Skip to content

Commit cfb8063

Browse files
Update README
1 parent 28f2939 commit cfb8063

File tree

1 file changed

+14
-23
lines changed

1 file changed

+14
-23
lines changed

README.md

Lines changed: 14 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
1-
UI Style Lang (Language)
2-
========================
3-
41
!["UI Style Lang"](https://github.com/Correct-Syntax/ui-style-lang/blob/master/assets/logo.png?raw=true "UI Style Lang")
52

6-
73
[![Documentation Status](https://readthedocs.org/projects/ui-style-lang/badge/?version=latest)](https://ui-style-lang.readthedocs.io/en/latest/?badge=latest)
84

95
UI Style Lang is a simple CSS-like language which allows for drawing and styling wxPython elements. Many UI Style Lang properties are the same as the normal (not short-hand) CSS3 properties. This provides a familiar syntax, especially for those with experience with CSS3.
@@ -14,23 +10,15 @@ If you are looking for an easy way to:
1410
* **Style the native wxPython widgets** from a stylesheet
1511
* **Create your own custom widgets in wxPython** that can be styled with a CSS-like stylesheet
1612

17-
...then UI Style Lang is likely the module you're looking for.
18-
19-
20-
# Direction of this project
13+
then UI Style Lang is likely the module you're looking for.
2114

22-
The direction of this project will mainly focus towards creating custom widgets which are styl-able via the UI Style Language. The aim is to imitate how (Qt Style Sheets) qss is to Qt except with wxPython custom-made widgets and UI Style Language.
2315

24-
If you would like to help out or have ideas, feel free to open a Github issue or contact me directly via my email. :)
16+
## Background
2517

18+
This was originally created as a "scratch-an-itch" project to get an idea I had for using the wxPython drawing API in a CSS way out of my head. Whether or not this is a good idea I don't know, but it's fun creating it.
2619

27-
# WIP/ TODO
2820

29-
* Custom widgets (spinbox, slider, buttons, etc)
30-
* SVG support(?)
31-
32-
33-
# Features
21+
## Features
3422

3523
* **Written in pure Python with minimal dependancies (just wxPython and the standard library)**
3624

@@ -46,15 +34,15 @@ If you would like to help out or have ideas, feel free to open a Github issue or
4634
* Supports loading from a stylesheet for easy theming
4735
* Support for styling app, panels, frames and static text widgets
4836

49-
...and more.
37+
and more.
5038

5139

52-
# Usage and Examples
40+
## Usage and Examples
5341

54-
See the [documentation](https://ui-style-lang.readthedocs.io/en/latest/) at Read the Docs and [full demo examples](https://github.com/Correct-Syntax/ui-style-lang/tree/master/demo) for information on usage...
42+
See the [documentation](https://ui-style-lang.readthedocs.io/en/latest/) at Read the Docs and [full demo examples](https://github.com/Correct-Syntax/ui-style-lang/tree/master/demo) for information on usage.
5543

5644

57-
# What does the syntax look like?
45+
## What does the syntax look like?
5846

5947
UI Style Lang (Stylesheet API) example:
6048

@@ -96,11 +84,14 @@ Python API example:
9684

9785
```
9886

99-
# Development
87+
88+
## Contributing
89+
90+
If you would like to help out or have ideas, feel free to open a Github issue.
10091

10192
Pull requests and/or feature suggestions are welcome!
10293

10394

104-
# License
95+
## License
10596

106-
UI Style Lang is licensed under the BSD 3-Clause license
97+
UI Style Lang is licensed under the BSD 3-Clause license.

0 commit comments

Comments
 (0)