remove old useless doc
This commit is contained in:
speediegq
parent
f15701a71e
commit
67a8642e1e
14
docs/doc-09
14
docs/doc-09
|
|
@ -1,11 +1,7 @@
|
|||
-- What is up with /usr/share --
|
||||
speedwm occasionally writes files to /usr/share. These files contain information about speedwm.
|
||||
-- Maintaining settings easily --
|
||||
speedwm is a personal fork of dwm and will therefore likely have keybinds and other options you may not like. Because of this, I recommend that you use the patching system to manage your "custom" settings
|
||||
speedwm has a patching system. It allows you to create a patch with your changes to options.h, options.mk, toggle.h and toggle.mk. To create a patch, simply make clean install once and then the docs folder will contain backups of your source code. If you perform changes to any of these four files, run make patch to create patches against the backups in docs and your modified files. Then once you're updating, do make patch_remove, git pull, make patch_install, and make clean install and all your settings will be there.
|
||||
The only (obvious) problem with doing this is that eventually the backup files patches are being created against will be pretty old causing patches to no longer apply correctly. If this is the case you will need to create new patches and backups.
|
||||
|
||||
- The documentation you're reading when you press Ctrl+Alt+h is stored there (as separate files).
|
||||
- speedwm-bindir is stored there which is a file that contains the path to the binaries on your system.
|
||||
- speedwm-compositor is stored there which is a file that contains the defined compositor.
|
||||
- speedwm-layouts is stored there which is a file that contains all available layouts.
|
||||
|
||||
These files are pretty important so it is recommended that you do not delete them.
|
||||
If you do end up deleting them though, you can just make clean install on speedwm again.
|
||||
If this seems like more effort than it is worth, maintaining your own fork is always an option. This allows you to perform any options you want yourself. This however doesn't allow you to grab any updates so this should be your second choice.
|
||||
|
||||
|
|
|
|||
10
docs/doc-10
10
docs/doc-10
|
|
@ -1,7 +1,7 @@
|
|||
-- Maintaining settings easily --
|
||||
speedwm is a personal fork of dwm and will therefore likely have keybinds and other options you may not like. Because of this, I recommend that you use the patching system to manage your "custom" settings
|
||||
speedwm has a patching system. It allows you to create a patch with your changes to options.h, options.mk, toggle.h and toggle.mk. To create a patch, simply make clean install once and then the docs folder will contain backups of your source code. If you perform changes to any of these four files, run make patch to create patches against the backups in docs and your modified files. Then once you're updating, do make patch_remove, git pull, make patch_install, and make clean install and all your settings will be there.
|
||||
The only (obvious) problem with doing this is that eventually the backup files patches are being created against will be pretty old causing patches to no longer apply correctly. If this is the case you will need to create new patches and backups.
|
||||
-- Additional note on autostart --
|
||||
If you wish to add autostart entries without recompiling, consider using $HOME/.config/speedwm-de/autostart.sh. This is a path added to autostart.h and you can fill it with anything you want.
|
||||
|
||||
If this seems like more effort than it is worth, maintaining your own fork is always an option. This allows you to perform any options you want yourself. This however doesn't allow you to grab any updates so this should be your second choice.
|
||||
Do note that it will NOT just run once. It will run every time you restart and start speedwm (signum 30 and 31 count as well).
|
||||
To get around this, you may wrap stuff in a function in the script and have some way of checking if it has ran before. If it hasn't, call the function.
|
||||
|
||||
An alternative is to use the $HOME/.config/speedwm-de/autostart_once.sh path. This one is autostarted by speedwm_run and is therefore not hardcoded and not affected by speedwm restarting. Just like the previous autostart script, it does not exist so you need to create it.
|
||||
|
|
|
|||
|
|
@ -1,7 +0,0 @@
|
|||
-- Additional note on autostart --
|
||||
If you wish to add autostart entries without recompiling, consider using $HOME/.config/speedwm-de/autostart.sh. This is a path added to autostart.h and you can fill it with anything you want.
|
||||
|
||||
Do note that it will NOT just run once. It will run every time you restart and start speedwm (signum 30 and 31 count as well).
|
||||
To get around this, you may wrap stuff in a function in the script and have some way of checking if it has ran before. If it hasn't, call the function.
|
||||
|
||||
An alternative is to use the $HOME/.config/speedwm-de/autostart_once.sh path. This one is autostarted by speedwm_run and is therefore not hardcoded and not affected by speedwm restarting. Just like the previous autostart script, it does not exist so you need to create it.
|
||||
|
|
@ -49,7 +49,6 @@ $DOCDIR/${PREFIX}example.fsignal \
|
|||
$DOCDIR/${PREFIX}doc-08 \
|
||||
$DOCDIR/${PREFIX}doc-09 \
|
||||
$DOCDIR/${PREFIX}doc-10 \
|
||||
$DOCDIR/${PREFIX}doc-11 \
|
||||
| sed 's|xsetroot -name "fsignal:||g; s|"||g' | grep -v "!!")" > /tmp/${PREFIX}doc
|
||||
|
||||
case "$ARG1" in
|
||||
|
|
@ -71,7 +70,6 @@ case "$ARG1" in
|
|||
sed "s|-- Important --|## Important|g" | \
|
||||
sed "s|-- .Xresources and Pywal --|## .Xresources and Pywal|g" | \
|
||||
sed "s|-- Fsignal --|## Fsignal|g" | \
|
||||
sed "s|-- What is up with /usr/share --|## What is up with /usr/share|g" | \
|
||||
sed "s|-- Additional note on autostart --|## Additional note on autostart|g" | \
|
||||
sed "s|-- Maintaining settings easily --|## Maintaining settings easily|g" | \
|
||||
sed "s|-- Switching run launcher --|## Switching run launcher|g" > ../README.md ;;
|
||||
|
|
@ -93,7 +91,6 @@ case "$ARG1" in
|
|||
sed "s|-- Important --|## Important|g" | \
|
||||
sed "s|-- .Xresources and Pywal --|## .Xresources and Pywal|g" | \
|
||||
sed "s|-- Fsignal --|## Fsignal|g" | \
|
||||
sed "s|-- What is up with /usr/share --|## What is up with /usr/share|g" | \
|
||||
sed "s|-- Maintaining settings easily --|## Maintaining settings easily|g" | \
|
||||
sed "s|-- Additional note on autostart --|## Additional note on autostart|g" | \
|
||||
sed "s|-- Switching run launcher --|## Switching run launcher|g" > ../README.md
|
||||
|
|
|
|||
Loading…
Reference in a new issue