aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMichael Kantor <michael@mikekantor.xyz>2025-09-01 15:33:24 -0400
committerMichael Kantor <michael@mikekantor.xyz>2025-09-01 15:33:24 -0400
commitac3aa3740a831f7bdeda342c6c4704568f01070c (patch)
treed8c2b3e0464c2561b274067df89d9c44d1a212a5 /README.md
parentd0ac4b9667108cd1eeb57b88072cf428cb953854 (diff)
Updated README. Added autostart.sh example. Removed function to defloat mpv window. Adjusted font and formatting of GroupBox widget because a qtile update raised the numbers too high. Added OpenRazer support to colors.py and wallpaper.py; the lights of a Razer keyboard will change to the sixth color from pywal. Fixed logging in ticker_gecko.py. Migrated to new qtile entry point in relevant files.HEADmaster
Diffstat (limited to 'README.md')
-rw-r--r--README.md65
1 files changed, 39 insertions, 26 deletions
diff --git a/README.md b/README.md
index ed9af74..69445a1 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,37 @@
## Mike's Custom Qtile Config
-### Features
+## Important!
+---
+Qtile has changed to the `uv` package manager and done away with the old entry point. Use the guide [here](https://docs.qtile.org/en/latest/manual/install/index.html), installing with widget dependencies, and run `uv pip install requests` in the directory where you cloned the qtile repository. I start qtile using `startx` with `$HOME/git/qtile/.venv/bin/python $HOME/git/qtile/.venv/bin/qtile start` in my `~/.xinitrc`.
+
+## Features
---
- Pywal Integration.
- Window Swallowing.
- Cryptocurrency Widget.
-Automatic reloads from wallpaper.py and colors.py assumes that the `qtile` script is located in `$HOME/git/qtile/bin/`. I use the master branch of qtile from github.
+Automatic reloads from wallpaper.py and colors.py assumes that the `qtile` script is located in `$HOME/git/qtile/.venv/bin/`. I use the master branch of qtile from GitHub.
### Dependencies
---
+- Zsh.
- [Mpd2](https://pypi.org/project/python-mpd2/). Host is ~/.mpd/socket. Port is 6600.
- [Ario](https://ario-player.sourceforge.net/).
- Imagemagick.
- [Pywal.](https://github.com/dylanaraps/pywal)
+- [OpenRazer.](https://openrazer.github.io)
- [Xsnow.](https://www.ratrabbit.nl/ratrabbit/xsnow/)
- Xautolock. Uses [slock](https://tools.suckless.org/slock/) with xres and message patches. I might put my fork up in the future.
- [Dmenu.](https://github.com/LukeSmithxyz/dmenu)
- [Flameshot.](https://flameshot.org/)
+- [Dunst.](https://github.com/dunst-project/dunst)
- Powerline Symbols.
+- Nimbus Sans.
+- Liberation Sans.
+
+### Usage
+---
+Copy `autostart.sh_example` to `autostart.sh` in the same directory. Make any necessary changes.
### Defaults
---
@@ -27,7 +40,7 @@ Default programs are located at the top of `config.py`.
- Terminal Emulator: [Alacritty.](https://github.com/alacritty/alacritty)
- Browser: [Librewolf.](https://librewolf.net/)
-### Key Bindings
+## Key Bindings
---
|Binding|Action|
|-|-|
@@ -91,29 +104,7 @@ Default programs are located at the top of `config.py`.
|MODKEY + SHIFT + Y|Send window to 'hidden' group.|
|MODKEY + CONTROL + Y|Send window to 'hidden' group and follow.|
|MODKEY + Q|Display clipboard contents as a QR code.|
-|MODKEY + CONTROL + E|Open the hammer editor.|
-
-### Copyright
----
-Copyright (c) 2012-2015 Tycho Andersen,
-Copyright (c) 2013 xarvh,
-Copyright (c) 2013 horsik,
-Copyright (c) 2013-2014 roger,
-Copyright (c) 2013 Tao Sauvage,
-Copyright (c) 2014 ramnes,
-Copyright (c) 2014 Sean Vig,
-Copyright (c) 2014 Adi Sieker.
-
-Modified by Michael Kantor
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this
- software and associated documentation files (the “Software”), to deal in the Software
- without restriction, including without limitation the rights to use, copy, modify,
- merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
- permit persons to whom the Software is furnished to do so, subject to the following
- conditions:
-The above copyright notice and this permission notice shall be included in all copies
- or substantial portions of the Software.
+|MODKEY + CONTROL + E|Open the hammer++ editor.|
## Custom Modules
@@ -164,3 +155,25 @@ Gets the price of a cryptocurrency from [CoinGecko](https://www.coingecko.com/).
- DOGE
More can be added to the "currencies" variable in the "match" function.
+
+## Copyright
+---
+Copyright (c) 2012-2015 Tycho Andersen,
+Copyright (c) 2013 xarvh,
+Copyright (c) 2013 horsik,
+Copyright (c) 2013-2014 roger,
+Copyright (c) 2013 Tao Sauvage,
+Copyright (c) 2014 ramnes,
+Copyright (c) 2014 Sean Vig,
+Copyright (c) 2014 Adi Sieker.
+
+Modified by Michael Kantor
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this
+ software and associated documentation files (the “Software”), to deal in the Software
+ without restriction, including without limitation the rights to use, copy, modify,
+ merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
+ permit persons to whom the Software is furnished to do so, subject to the following
+ conditions:
+The above copyright notice and this permission notice shall be included in all copies
+ or substantial portions of the Software.