bcst/README.md
2020-04-22 10:03:04 +02:00

18 lines
574 B
Markdown

# 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