Marty/dotfiles
1
0
Fork 0
Code Issues 3 Pull requests Projects Releases Wiki Activity

[polybar] Update module README

Browse source 
Slight updates to readme, fixing image link, pointing main readme to the
right location, rewording bib dependencies.
This commit is contained in:
Marty Oehme 2020-05-11 16:50:35 +02:00
parent 1d80d988b7
commit dba4877983
No known key found for this signature in database
GPG key ID: 0CCB0526EFB9611A
2 changed files with 10 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -45,7 +45,7 @@ Enjoy!
* [`nvim`](https://neovim.io/) - Neovim configuration * [`nvim`](https://neovim.io/) - Neovim configuration
* [`pandoc`](https://pandoc.org) - Pandoc plaintext transformation options (mostly latex templates) * [`pandoc`](https://pandoc.org) - Pandoc plaintext transformation options (mostly latex templates)
* [`picom`](https://github.com/yshui/picom) - X11 compositor (maintained fork from compton) * [`picom`](https://github.com/yshui/picom) - X11 compositor (maintained fork from compton)
* [`polybar`](https://github.com/polybar/polybar) - Easy to customize statusbar * [`polybar`](polybar/README.md) - Easy to customize statusbar
* [`qutebrowser`](https://github.com/qutebrowser/qutebrowser) - vim-key enabled web browser * [`qutebrowser`](https://github.com/qutebrowser/qutebrowser) - vim-key enabled web browser
* [`rofi`](https://github.com/davatorium/rofi) - Application launcher, dmenu replacement * [`rofi`](https://github.com/davatorium/rofi) - Application launcher, dmenu replacement
* [`sxhkd`](https://github.com/baskerville/sxhkd) - X11 hotkey manager * [`sxhkd`](https://github.com/baskerville/sxhkd) - X11 hotkey manager
@ -60,7 +60,7 @@ Enjoy!
* `rofi` contains additional scripts and a simple theming framework for rofi and should probably be reorganized to put the correct files into the correct directories (per xdg) at some point. * `rofi` contains additional scripts and a simple theming framework for rofi and should probably be reorganized to put the correct files into the correct directories (per xdg) at some point.
* `.local/bin` in `scripts` `stow` unit contains most executable user scripts. Most of these have been migrated to their corresponding modules (e.g. if a script exclusively targets git functionality, it will live there), some stand-alone scripts remain however. * `.local/bin` in `scripts` `stow` unit contains most executable user scripts. Most of these have been migrated to their corresponding modules (e.g. if a script exclusively targets git functionality, it will live there), some stand-alone scripts remain however.
* `.local/share/pandoc` contains configuration for academic latex (pandoc, really) writing and is of interest if you want to use this functionality. * `.local/share/pandoc` contains configuration for academic latex (pandoc, really) writing and is of interest if you want to use this functionality.
* `.xinitrc` is used for x initialization and program startup. * `.xinitrc` is used for x initialization and program startup. At some point, some of the consistently running applications may be moved to runit as supervised services.
* Generally, directories starting with a . are only meaningful for the *repository* not for the functionality of the machine that these dotfiles are deployed on. That means `.gitlab-ci.yml`, `.assets/`, `.stowrc` and similar files and directories will not show up in the final deployment in any home directory. Perhaps they should be called dotdot-files since they're the dotfiles for my dotfiles. 🙂 (Also, 'dotfiles'.) * Generally, directories starting with a . are only meaningful for the *repository* not for the functionality of the machine that these dotfiles are deployed on. That means `.gitlab-ci.yml`, `.assets/`, `.stowrc` and similar files and directories will not show up in the final deployment in any home directory. Perhaps they should be called dotdot-files since they're the dotfiles for my dotfiles. 🙂 (Also, 'dotfiles'.)
[^shreq]: I may remove this requirement in the future to make modules more self-contained. However, relying on some base utility scripts makes it easier to avoid duplicating such functionality for each individual script in other modules. [^shreq]: I may remove this requirement in the future to make modules more self-contained. However, relying on some base utility scripts makes it easier to avoid duplicating such functionality for each individual script in other modules.

12
polybar/README.md
View file

@ -32,7 +32,7 @@ The i3 workspaces module is pretty simple and self-explanatory. It shows all exi
Additionally, if an i3 mode is active, it will be displayed next to the workspaces in a stark color to notice the mode being active. Additionally, if an i3 mode is active, it will be displayed next to the workspaces in a stark color to notice the mode being active.
![mode](.assets/polybar/i3-highlight.png) -- focus on workspace 3, 'Media' mode active ![mode](.assets/polybar/i3-mode.png) -- focus on workspace 3, 'Media' mode active
Workspaces can be cycled with the mouse-wheel when hovering over the module, or can be invoked by clicking on the icons. Workspaces can be cycled with the mouse-wheel when hovering over the module, or can be invoked by clicking on the icons.
@ -56,11 +56,15 @@ The standard polybar date display. Displays current date (DD/MM) and current tim
![extended clock](.assets/polybar/clock_alt.png) ![extended clock](.assets/polybar/clock_alt.png)
## Upcoming Bib readings ## Upcoming Bibtex readings
Depends on the [`bibtex`](bibtex/) module being installed, specifically a `$BIBFILE` variable pointing to the system library, and a `bib_due` script. Depends on the [`bibtex`](bibtex/) module being installed, more specifically:
Displays the library readings remaining for the week in simple numerical fashion. On click invokes the full `bib_due` script to show further information on the upcoming readings, requiring `dmenu` or `rofi` to display them. * the `bib-due` script accessible as a program
* a `$BIBFILE` environment variable pointing to the bibtex library (or at least, the relevant library of the system)
* optionally: `rofi` (or `dmenu`) to enable listing of readings on click
Displays the library readings remaining for the week in simple numerical fashion. On click invokes the full `bib_due` script to show further information on the upcoming readings, requiring either `dmenu` or `rofi` to display them.
## System information ## System information