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

repo: Move some assets to gitlab wiki

Browse source 
Moved some of the overview images and animations from the repository to
the repository's wiki, to save size when cloning the repo.

There will be a point when I have to think about the structure of the
readme files and displayed media since it does not belong *directly* to
the repository (that are only dotfiles, and only they should, ideally,
be cloned to new machines) but they also fall into somewhat of a
silo-problem when hosted on gitlab and I want to migrate e.g. to gitea.

This is a point I will have to think about further.
This commit is contained in:
Marty Oehme 2021-04-05 13:15:11 +02:00
parent b0b1d0b64a
commit b8d680a379
Signed by: Marty
GPG key ID: B7538B8F50A1C800
3 changed files with 8 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
.assets/gapless.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 452 KiB

BIN
.assets/gaps.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 502 KiB

15
README.md
View file

@ -1,4 +1,4 @@
# dotfiles Read-Me and Roadmap
# `~/🌹`
## What's in these dotfiles
@ -13,7 +13,7 @@
* [x] quick directory jumping using z, with fzf integration
* [x] fzf integrations for bibtex citation, vim buffer management, most recently used switching, shell command history, and more
![Overview](.assets/gaps.png)
[![Styler recoloring demo](https://gitlab.com/marty-oehme/dotfiles/-/wikis/uploads/bde87deda694590a2e08e21552e11309/styler.webp)](https://gitlab.com/marty-oehme/dotfiles/-/wikis/uploads/90894e53eff378db4d7f9f49e7a69fab/styler.mp4)
## Quick-Start
@ -22,15 +22,14 @@ The dotfiles use `GNU stow` to link themselves in the home directory. You can cl
I would recommend doing a `git clone --recursive` for this repository, since it contains git [submodules](https://nering.dev/2016/git-submodules-vs-subtrees/), which will then automatically get pulled in as well. Of course, you can do it non-recursively and then just pull those modules selectively which you actually want.
Once in the repository directory, when you then run `./install.sh` it will install many of the packages I use (though they are probably slightly out-of-date) and link the dotfiles into the home directory.
Since it is based on `stow`, it will not overwrite anything already in the home directory (though you can force it to if you really want, using `stow --override='.*'` -- I do not recommend this).
If you do not want to install any packages, but only link the dotfiles run `stow -S */` from the main repository directory.
Since dotfiles management is based on `stow`, it will not overwrite anything already in the home directory (though you can force it to if you really want, using `stow --override='.*'` -- I do not recommend this).
After all files are linked and you open a new shell session, the `dotlink` alias will allow you to re-link all dotfiles from anywhere on the system.[^1]
[^1]: This alias only works when the dotfiles are cloned into `~/.dotfiles` mirroring my setup.
[^1]: This alias only works when the dotfiles are cloned into `~/.dotfiles`, mirroring my setup.
This is due to a hard-coded cd into this directory.
If your dotfiles lie in another directory and you want to use the dotlink alias, simply change the corresponding line in `_bootstrap/.config/sh/alias.d/dotlink.sh`]
If your dotfiles lie in another directory and you want to use the dotlink alias, simply change the corresponding line in `bootstrap/.config/sh/alias.d/dotlink.sh`]
Both automatic installation paths are presumably somewhat brittle. In any case, I would suggest to manually look through the files for things you want instead of copying and activating everything.
Dotfiles are too personal to be standardized like that.
@ -39,6 +38,8 @@ Enjoy!
## Main Modules
![Overview - an older image of the dotfile desktop with gaps, showing git logs, styler logs, duckduckgo in a browser, and a vifm view of the dotfiles themselves](https://gitlab.com/marty-oehme/dotfiles/-/wikis/uploads/aaf0319d575dc192ea0f4bd6eaf83c08/gaps.png)
* [`alacritty`](https://github.com/jwilm/alacritty) - Terminal emulator (GPU accelerated and customizable)
* [`i3`](https://i3wm.org/) - Tiling window manager
* [`polybar`](polybar/README.md) - Easy to customize statusbar
@ -66,4 +67,4 @@ Enjoy!
[^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.
![Gapless](.assets/gapless.png)
![Gapless - the same image as above, only displayed without gaps](https://gitlab.com/marty-oehme/dotfiles/-/wikis/uploads/21791f77da013cdac64f11eff61584e3/gapless.png)