caskd
/
ZSHFiles
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fix readme formatting

This commit is contained in:
Alex 2020-05-27 22:48:14 +02:00
parent 2d8c7613dc
commit 4a53ea99ff
Signed by: caskd
GPG Key ID: F92BA85F61F4C173
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -17,19 +17,19 @@ Some custom prompts depend on these binaries in your path:
While i do attempt to make this usable widely, don't rely on it. If you want to use this and have it work as you want it, it's expected that you can read manual pages and know at least a bit of shell scripting.
**These variables should be set in your .zshenv or your profiles/environment files**
## These variables should be set in your .zshenv or your profiles/environment files
## ZDOTDIR
### ZDOTDIR
This environment variable should be set to the root of your repository (usually ~/.config/zsh or ~/.zsh)
## zstyles
### zstyles
### :custom:preferences
#### :custom:preferences
Because font support detection is a bit complicated, the `prompt` variable in this zstyle allows you to manually toggle on a specific prompt (now only p9k is available)
### :custom:prompts:weather
#### :custom:prompts:weather
This should be your location in the `woeid` format. https://en.wikipedia.org/wiki/WOEID
The weather is fetched from [MetaWeather](https://metaweather.com) (props to them for having a API that is authentication-free) every 12h. It is not updated live in the prompt because i don't really expect people to have their terminal open for 12h but it can be updated manually by deleting the disk cache stored at `$CACHEPATH/weather` and unsetting the `_cprompts_weather` variable in this specific order.
### :custom:prompts:covid
#### :custom:prompts:covid
This is a country slug for your country. This is used in the `covid_19()` prompt which shows you the daily actively infected people. It behaves the same as the weather one except that it is updated every 24h and is fetched from [Covid19API](https://api.covid19api.com/) which has a really nice JSON api which is completly free and requires no authentication.