update a few more things
This commit is contained in:
speedie
parent
4bef4bf538
commit
864e154084
21
Makefile
21
Makefile
|
|
@ -181,7 +181,7 @@ page_release:
|
|||
|
||||
upload:
|
||||
chmod +x scripts/speedwm-mkpage
|
||||
./scripts/speedwm-mkpage -ulspeedwm
|
||||
./scripts/speedwm-mkpage --release
|
||||
@echo "Uploaded everything."
|
||||
|
||||
page:
|
||||
|
|
@ -190,12 +190,12 @@ page:
|
|||
page_html:
|
||||
chmod +x scripts/speedwm-mkpage
|
||||
chmod +x scripts/speedwm-help
|
||||
./scripts/speedwm-mkpage -mkpage
|
||||
./scripts/speedwm-mkpage --make-page
|
||||
|
||||
page_php:
|
||||
chmod +x scripts/speedwm-mkpage
|
||||
chmod +x scripts/speedwm-help
|
||||
./scripts/speedwm-mkpage -mkpage
|
||||
./scripts/speedwm-mkpage --make-page
|
||||
mv readme.html readme.php
|
||||
|
||||
page_install:
|
||||
|
|
@ -217,27 +217,32 @@ page_push:
|
|||
echo ${PAGEDIR} > /tmp/speedwm-htmldir
|
||||
chmod +x scripts/speedwm-mkpage
|
||||
chmod +x scripts/speedwm-help
|
||||
./scripts/speedwm-mkpage -page-push
|
||||
./scripts/speedwm-mkpage --release-page
|
||||
|
||||
html:
|
||||
chmod +x scripts/speedwm-mkpage
|
||||
chmod +x scripts/speedwm-help
|
||||
./scripts/speedwm-mkpage -mkhtml
|
||||
./scripts/speedwm-mkpage --make-html
|
||||
|
||||
php:
|
||||
chmod +x scripts/speedwm-mkpage
|
||||
chmod +x scripts/speedwm-help
|
||||
./scripts/speedwm-mkpage -mkpage
|
||||
./scripts/speedwm-mkpage --make-page
|
||||
mv readme.html readme.php
|
||||
|
||||
markdown:
|
||||
chmod +x scripts/speedwm-mkpage
|
||||
chmod +x scripts/speedwm-help
|
||||
./scripts/speedwm-mkpage -mkmd
|
||||
./scripts/speedwm-mkpage --make-markdown
|
||||
|
||||
man:
|
||||
chmod +x scripts/speedwm-mkpage
|
||||
chmod +x scripts/speedwm-help
|
||||
./scripts/speedwm-mkpage --make-man
|
||||
|
||||
readme:
|
||||
chmod +x scripts/speedwm-mkpage
|
||||
chmod +x scripts/speedwm-help
|
||||
./scripts/speedwm-mkpage -mk
|
||||
|
||||
.PHONY: all options clean dist install install_only_bin install_only_misc modules_install uninstall help docs page page_html page_php page_install page_release html php markdown readme page_push upload release previmg_install css_install
|
||||
.PHONY: all options clean dist install install_only_bin install_only_misc modules_install uninstall help docs page page_html page_php page_install page_release html php markdown man readme page_push upload release previmg_install css_install
|
||||
|
|
|
|||
62
README.md
62
README.md
|
|
@ -239,54 +239,54 @@ These binds can be activated using your mouse
|
|||
|
||||
## Dependencies
|
||||
|
||||
These are absolutely necessary, speedwm will NOT compile without them
|
||||
- libxft
|
||||
- pango
|
||||
- libXinerama
|
||||
These are absolutely necessary, speedwm will NOT compile without them
|
||||
- libxft
|
||||
- pango
|
||||
- libXinerama
|
||||
- Can be disabled through editing toggle.mk if you're not interested in multiple monitors.
|
||||
- imlib2
|
||||
- imlib2
|
||||
- Tag previews, Window icons. Can be disabled through editing toggle.mk and toggle.h if you don't want these features.
|
||||
- yajl
|
||||
- yajl
|
||||
- Required for the IPC patch. If the IPC patch is disabled, you do not need this.
|
||||
- tcc
|
||||
- tcc
|
||||
- Very minimal C compiler that speedwm uses to speed up compile times. If you don't want this dependency, edit host.mk and set CC to 'cc' (or what you prefer).
|
||||
|
||||
## Features
|
||||
|
||||
These are necessary for certain features and keybinds.
|
||||
If you want to use an alternative, change it in options.h and/or keybinds.h and mouse.h.
|
||||
These are necessary for certain features and keybinds.
|
||||
If you want to use an alternative, change it in options.h and/or keybinds.h and mouse.h.
|
||||
|
||||
- dmenu
|
||||
- dmenu
|
||||
- NOTE: dmenu is required for most scripts included with this build of speedwm. My build is required for proper Pywal support.
|
||||
- picom
|
||||
- picom
|
||||
- Optional but speedwm looks sort of ugly without a compositor.
|
||||
- xrdb (Install if you want .Xresources support)
|
||||
- pywal (Install if you want pywal support. Requires swal (the default way to set wallpapers) or a tool that supports the correct signal for instant reloading)
|
||||
- j4-dmenu-desktop
|
||||
- xrdb (Install if you want .Xresources support)
|
||||
- pywal (Install if you want pywal support. Requires swal (the default way to set wallpapers) or a tool that supports the correct signal for instant reloading)
|
||||
- j4-dmenu-desktop
|
||||
- Required for dmenu desktop entries..
|
||||
|
||||
## Software
|
||||
This build of speedwm comes with binds for software.
|
||||
You can add, change and remove keybinds by editing 'keybinds.h' and running 'make clean install'.
|
||||
This build of speedwm comes with binds for software.
|
||||
You can add, change and remove keybinds by editing 'keybinds.h' and running 'make clean install'.
|
||||
|
||||
- libspeedwm
|
||||
- speedwm-extras
|
||||
- libspeedwm
|
||||
- speedwm-extras
|
||||
- Important metapackage containing extra scripts that speedwm makes use of. (https://codeberg.org/speedie/speedwm-extras)
|
||||
- st (Terminal)
|
||||
- qutebrowser (Web browser)
|
||||
- htop (Status monitor)
|
||||
- newsboat (RSS reader)
|
||||
- zathura (PDF reader)
|
||||
- cmus (Default music player)
|
||||
- st (Terminal)
|
||||
- qutebrowser (Web browser)
|
||||
- htop (Status monitor)
|
||||
- newsboat (RSS reader)
|
||||
- zathura (PDF reader)
|
||||
- cmus (Default music player)
|
||||
- Default status bar also has support for moc (Music On Console)
|
||||
- neovim (Text editor)
|
||||
- neomutt (Email client)
|
||||
- lf (File manager)
|
||||
- slock (Lock screen)
|
||||
- weechat (IRC client)
|
||||
- tmux (Used for the music player and IRC client)
|
||||
- neovim (Text editor)
|
||||
- neomutt (Email client)
|
||||
- lf (File manager)
|
||||
- slock (Lock screen)
|
||||
- weechat (IRC client)
|
||||
- tmux (Used for the music player and IRC client)
|
||||
|
||||
And everything under 'Features'.
|
||||
And everything under 'Features'.
|
||||
|
||||
## Important
|
||||
|
||||
|
|
|
|||
|
|
@ -6,6 +6,7 @@ cd scripts
|
|||
export DOCDIR="../docs" # Set documentation directory so that it will ALWAYS use the latest documentation
|
||||
export USEPREFIX="false" # Set empty prefix
|
||||
|
||||
# make page
|
||||
MKPAGE() {
|
||||
./speedwm-help --generate-html
|
||||
./speedwm-help --generate-page
|
||||
|
|
@ -15,6 +16,7 @@ MKPAGE() {
|
|||
echo "Created readme.html"
|
||||
}
|
||||
|
||||
# push page only
|
||||
PUSHPAGE() {
|
||||
HTMLDIR=$(cat /tmp/speedwm-htmldir)
|
||||
cd $HTMLDIR || exit 1
|
||||
|
|
@ -24,34 +26,33 @@ PUSHPAGE() {
|
|||
exit 1
|
||||
}
|
||||
|
||||
# make html
|
||||
MKHTML() {
|
||||
MKMD
|
||||
./speedwm-help --generate-html
|
||||
cd ..
|
||||
echo "Created readme.html"
|
||||
}
|
||||
|
||||
# make markdown
|
||||
MKMD() {
|
||||
./speedwm-help --generate-markdown
|
||||
cd ..
|
||||
echo "Created README.md"
|
||||
}
|
||||
|
||||
MK() {
|
||||
./speedwm-help -w
|
||||
# make man page
|
||||
MK1() {
|
||||
MKMD
|
||||
./speedwm-help --generate-man
|
||||
cd ..
|
||||
echo "Created readme"
|
||||
}
|
||||
|
||||
# Perform actions based on user input
|
||||
case "$1" in
|
||||
"") echo "speedwm-mkpage\nNo arguments | Show the help screen\n-h | Show the help screen\n-mkpage | Create full page with templates from docs/\n-mkhtml | Create HTML document based on speedwm documentation\n-mkmd | Create markdown file (usually for use with GitHub repositories)\n-mk | Copy the output of speedwm-help -a to 'readme'.\n-ulspeedwm | Auto-push speedwm changes\n" ; exit 0 ;;
|
||||
"-help") $0 && exit 0 ;;
|
||||
"-h") $0 && exit 0 ;;
|
||||
"-mkpage") MKPAGE && exit 0 ;;
|
||||
"-mkhtml") MKHTML && exit 0 ;;
|
||||
"-mkmd") MKMD && exit 0 ;;
|
||||
"-mk") MK && exit 0 ;;
|
||||
"-page-push") PUSHPAGE && exit 0 ;;
|
||||
"-ulspeedwm") cd .. && git add * && git commit -a -m "speedwm-mkpage: Auto-pushed speedwm changes!" && git push && exit 0 ;;
|
||||
"--make-man") MK1 && exit 0 ;;
|
||||
"--make-page") MKPAGE && exit 0 ;;
|
||||
"--make-html") MKHTML && exit 0 ;;
|
||||
"--make-markdown") MKMD && cd .. ; exit 0 ;;
|
||||
"--release-page") PUSHPAGE && exit 0 ;;
|
||||
"--release") cd .. && git add * && git commit -a -m "speedwm-mkpage: Auto-pushed speedwm changes!" && git push && exit 0 ;;
|
||||
esac
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue