Skip to content

Commit

Permalink
Add README.md with sample usage
Browse files Browse the repository at this point in the history
  • Loading branch information
PoLaKoSz committed Mar 5, 2020
1 parent e0ff8d6 commit 2d3f12d
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# qbt-theme

## Tool to crate .qbttheme files for [qBittorrent](https://www.qbittorrent.org/).

### Requirements

- [rcc](https://pypi.org/project/PySide2/) to compile `.qres` binary resource files
- on Windows rcc.exe should be added to the PATH (`pip show PySide2` to get the installation path)

#### For development

- [qtsass](https://pypi.org/project/qtsass/) to compile SCSS

### Usage

#### Get help

``` sh
$ python make-resource.py -h
```

### Compile `material-white/stylesheet.scss` to `stylesheet.qss`

``` sh
$ cd material-white
$ python
>>> import qtsass
>>> qtsass.compile_filename('stylesheet.scss', 'stylesheet.qss')
```


#### Compile the `ubuntu` theme to a file called `test.qbtheme`

``` sh
$ python make-resource.py -s a -o test files ubuntu/*
```

0 comments on commit 2d3f12d

Please sign in to comment.