Merge branch 'master' into dockerize

Merging  master into dockerize
This commit is contained in:
Paul Houser 2020-08-24 17:17:20 -07:00
commit b1d7778750
2 changed files with 37 additions and 8 deletions

View File

@ -17,18 +17,47 @@ A terminal-style home page replicating the tree command.
</h1>
</div>
# Usage
## Installation
To install StartTree for the first time, run the following commands:
(Note: If the `~/.config/StartTree` directory already exists, `init.py` will not execute to prevent accidentally overwriting a custom config. )
```
git clone https://github.com/Paul-Houser/StartTree.git
cd StartTree
./init.py
./generate.py
```
This will create the directory `~/.config/StartTree` containing the default `config.yaml`, as well as generate the html/css, which you can view by pointing your browser at `$HOME/.cache/StartTree/index.html`.
## Config
The config should be placed in `~/.config/StartTree/config.yaml`
## Updating the HTML
To re-generate the html/css after editing the config, navigate to the `StartTree` directory and execute `./generate.py`.
# Example Config
```yaml
font_size: 15
theme: void
tree_1:
general:
google: "https://www.google.com/"
youtube: "https://www.youtube.com/"
font_size: 22 # specify font size
theme: void # specify the name of a theme in the themes/ directory, or use 'pywal'
tree_1: # each column should be named 'tree_X' where X is unique for each tree.
general: # Header name
github: "https://www.github.com/" # Link-text: url
gmail: "https://mail.google.com/"
reddit:
homepage: "https://www.reddit.com/"
# the following is an example of naming a link something with a space,
# or containing characters that cannot be in a yaml variable name.
frontpage:
- "https://www.reddit.com/"
- "front page" #
unixporn: "https://www.reddit.com/r/unixporn/"
tree_2:
other:
archwiki:
- "https://archlinux.org/"
- "arch wiki"
hulu: "https://www.hulu.com/"
netflix: "https://www.netflix.com/"
youtube: "https://www.youtube.com/"
```
# Themes

Binary file not shown.

Before

Width:  |  Height:  |  Size: 730 KiB

After

Width:  |  Height:  |  Size: 647 KiB