bcst/README.md

19 lines
574 B
Markdown
Raw Normal View History

2020-04-22 08:20:06 +02:00
# Beautiful Custom Start Page
2020-04-21 15:48:24 +02:00
2020-04-22 08:20:06 +02:00
### 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:
2020-04-22 10:03:04 +02:00
> bcst -e \<your-theme> > resources.json
2020-04-21 15:48:24 +02:00
2020-04-22 08:20:06 +02:00
This, will create a `resources.json` in the current directory. Now, you can customize it to your needs. Then, generate your start page:
2020-04-22 10:03:04 +02:00
> bcst -g \<your-theme> resources.json \<start-page-destination>
2020-04-22 08:20:06 +02:00
2020-04-22 10:03:04 +02:00
And voila!
2020-04-22 08:20:06 +02:00
### Submit your own theme
TODO
2020-04-21 15:48:24 +02:00