aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 616a9e162d933d64ee2f8216594b77476b3f0653 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# Beautiful Custom Start Page

### Basic usage
**bcst** allow you to create a beautiful start page very quickly. To install **bcst** run
`pip install bcst`. Then choose a theme (screenshots are availaible on the package repository):
> bcst -l
> 
Next step, extract the theme resources:
> bcst -e \<your-theme> > resources.json

This, will create a `resources.json` in the current directory. Now, you can customize it to your needs. Then, generate your start page:
> bcst -g \<your-theme> resources.json \<start-page-destination>

And voila!

### Submit your own theme
TODO