speedie/startpage
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

document it a little better

Browse source
This commit is contained in:
speedie 2023-06-20 15:52:42 +02:00
parent 52872fc0b1
commit 810992710a
1 changed files with 18 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -1,24 +1,32 @@
![image](startpage.png?raw=true "image")
# startpage
![image](startpage.png?raw=true "image")
JS and PHP free minimal startpage with pywal and dynamic wallpaper support.
This startpage is meant to be used locally, not hosted on a server, because
that way it's hackable and scriptable, and you are meant to edit the HTML
yourself and modify it to fit your needs.
## How does this work?
The colors work by using a shell script to write colors into a style sheet
the HTML page loads. Loading your wallpaper is possible by using hooks in
your wallpaper utility to copy the wallpaper from its actual path to a
path startpage can read every time a new wallpaper is set.
## Usage with qutebrowser
Clone the repository into ~/.config/qutebrowser and add these two lines to config.py.
```
```Python
config.set('url.start_pages','~/.config/qutebrowser/startpage/index.html')
config.set('url.default_page','~/.config/qutebrowser/startpage/index.html')
```
You don't need to edit script-qutebrowser.sh if you're using wallpaper-spmenu
as it is set by default.
as it is set by default. You do need to run this script in your `post_write_script()`
function though. See 'To copy in the wallpaper' for more information.
## Usage with Chromium based browsers
@ -47,13 +55,15 @@ see 'To copy in the wallpaper'.
## Usage for other browsers
Clone the repository and edit script-generic.sh and change PREFIX if you aren't
using speedwm. Check the wiki on how to set a start page for your specific
browser.
using wallpaper-spmenu. Check the wiki/documentation for your browser if you
aren't sure how to set a start page for your specific browser.
## To copy in the wallpaper
If you're using wallpaper-spmenu, see [the spmenu wiki](https://spmenu.speedie.site).
Otherwise find some other method to copy the current wallpaper.
If you're using wallpaper-spmenu, see [this
article](https://spmenu.speedie.site/Pywal+integration+with+wallpaper-spmenu)
for more information. Otherwise find some other method to copy the current
wallpaper.
## Pywal