mirror of
				https://github.com/gaschz/dotfiles.git
				synced 2025-11-04 05:28:56 +01:00 
			
		
		
		
	doc: lint markdown files
This commit is contained in:
		
							parent
							
								
									46d0753329
								
							
						
					
					
						commit
						56191dab6d
					
				
							
								
								
									
										58
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										58
									
								
								README.md
									
									
									
									
									
								
							@ -1,11 +1,11 @@
 | 
			
		||||
# dotfiles
 | 
			
		||||
 | 
			
		||||
<!--
 | 
			
		||||
SPDX-FileCopyrightText: 2023 - 2024 Benjamin Grande M. S. <ben.grande.b@gmail.com>
 | 
			
		||||
 | 
			
		||||
SPDX-License-Identifier: CC-BY-SA-4.0
 | 
			
		||||
-->
 | 
			
		||||
 | 
			
		||||
# dotfiles
 | 
			
		||||
 | 
			
		||||
Dotfiles.
 | 
			
		||||
 | 
			
		||||
## Table of Contents
 | 
			
		||||
@ -21,21 +21,21 @@ Dotfiles.
 | 
			
		||||
 | 
			
		||||
Configuration and scripts targeting:
 | 
			
		||||
 | 
			
		||||
-   Usability:
 | 
			
		||||
    -   Vi keybindings for application movement
 | 
			
		||||
    -   Emacs keybindings for command-line editing
 | 
			
		||||
    -   XDG Specification to not clutter $HOME
 | 
			
		||||
-   Portability:
 | 
			
		||||
    -   POSIX compliant code
 | 
			
		||||
    -   Drop-in configuration files
 | 
			
		||||
    -   Tested in Qubes OS Dom0, Debian, Fedora, OpenBSD
 | 
			
		||||
-   Tasks:
 | 
			
		||||
    -   GUI: x11, gtk
 | 
			
		||||
    -   SCM: git, tig, git-shell
 | 
			
		||||
    -   Keys: gpg, ssh
 | 
			
		||||
    -   Networking: curl, urlview, wget, w3m
 | 
			
		||||
    -   Productivity: tmux, vim
 | 
			
		||||
    -   Shell: sh, bash, zsh, less, dircolors
 | 
			
		||||
*   Usability:
 | 
			
		||||
    *   Vi keybindings for application movement
 | 
			
		||||
    *   Emacs keybindings for command-line editing
 | 
			
		||||
    *   XDG Specification to not clutter $HOME
 | 
			
		||||
*   Portability:
 | 
			
		||||
    *   POSIX compliant code
 | 
			
		||||
    *   Drop-in configuration files
 | 
			
		||||
    *   Tested in Qubes OS Dom0, Debian, Fedora, OpenBSD
 | 
			
		||||
*   Tasks:
 | 
			
		||||
    *   GUI: x11, gtk
 | 
			
		||||
    *   SCM: git, tig, git-shell
 | 
			
		||||
    *   Keys: gpg, ssh
 | 
			
		||||
    *   Networking: curl, urlview, wget, w3m
 | 
			
		||||
    *   Productivity: tmux, vim
 | 
			
		||||
    *   Shell: sh, bash, zsh, less, dircolors
 | 
			
		||||
 | 
			
		||||
## Installation
 | 
			
		||||
 | 
			
		||||
@ -48,11 +48,13 @@ If you want a machine independent installation, choose the [Script](#script)
 | 
			
		||||
installation method.
 | 
			
		||||
 | 
			
		||||
Install everything in a qube:
 | 
			
		||||
 | 
			
		||||
```sh
 | 
			
		||||
sudo qubesctl --skip-dom0 --targets=QUBE state.apply dotfiles.copy-all
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
Install specific files in Dom0:
 | 
			
		||||
 | 
			
		||||
```sh
 | 
			
		||||
sudo qubesctl state.apply dotfiles.copy-dom0,dotfiles.copy-sh,dotfiles.copy-vim,dotfiles.copy-x11
 | 
			
		||||
```
 | 
			
		||||
@ -60,14 +62,17 @@ sudo qubesctl state.apply dotfiles.copy-dom0,dotfiles.copy-sh,dotfiles.copy-vim,
 | 
			
		||||
### Script
 | 
			
		||||
 | 
			
		||||
You can simply deploy all configurations with:
 | 
			
		||||
 | 
			
		||||
```sh
 | 
			
		||||
./files/setup.sh
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
Or target specific ones by specifying the directory name:
 | 
			
		||||
 | 
			
		||||
```sh
 | 
			
		||||
./files/setup.sh sh bash
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
Note that some files might depend on other directories, specially `sh` which
 | 
			
		||||
is a base for `bash` and `zsh` but might also have environment variables for
 | 
			
		||||
`net` and `vim`. It also adds `$HOME/.local/bin` and
 | 
			
		||||
@ -75,11 +80,13 @@ is a base for `bash` and `zsh` but might also have environment variables for
 | 
			
		||||
scripts, install the `sh` directory.
 | 
			
		||||
 | 
			
		||||
Reload your shell:
 | 
			
		||||
 | 
			
		||||
```sh
 | 
			
		||||
exec $SHELL
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
Reload you X server:
 | 
			
		||||
 | 
			
		||||
```sh
 | 
			
		||||
. ~/.config/x11/xprofile
 | 
			
		||||
```
 | 
			
		||||
@ -94,14 +101,14 @@ configuration is implemented by including a local file per application.
 | 
			
		||||
 | 
			
		||||
Supported programs and the expected file names in `$HOME`:
 | 
			
		||||
 | 
			
		||||
- **bash**: .bashrc.local
 | 
			
		||||
- **git**:  .gitconfig.local
 | 
			
		||||
- **sh**:   .profile.local, .shrc.local, .config/sh/profile.d/ (.sh suffix)
 | 
			
		||||
- **ssh**:  .ssh/config.d/ (.conf suffix), .ssh/known_hosts.d/ (.host suffix)
 | 
			
		||||
- **tmux**: .tmux.conf.local
 | 
			
		||||
- **vim**:  .vimrc.local
 | 
			
		||||
- **x11**:  .xprofile.local, .config/x11/xprofile.d/ (.sh suffix)
 | 
			
		||||
- **zsh**:  .zshrc.local
 | 
			
		||||
*   **bash**: .bashrc.local
 | 
			
		||||
*   **git**:  .gitconfig.local
 | 
			
		||||
*   **sh**:   .profile.local, .shrc.local, .config/sh/profile.d/ (.sh suffix)
 | 
			
		||||
*   **ssh**:  .ssh/config.d/ (.conf suffix), .ssh/known_hosts.d/ (.host suffix)
 | 
			
		||||
*   **tmux**: .tmux.conf.local
 | 
			
		||||
*   **vim**:  .vimrc.local
 | 
			
		||||
*   **x11**:  .xprofile.local, .config/x11/xprofile.d/ (.sh suffix)
 | 
			
		||||
*   **zsh**:  .zshrc.local
 | 
			
		||||
 | 
			
		||||
## License
 | 
			
		||||
 | 
			
		||||
@ -110,6 +117,7 @@ list all licenses and copyrights and keep them up-to-date here.
 | 
			
		||||
 | 
			
		||||
The easiest way to get the copyright and license of the project with the reuse
 | 
			
		||||
tool:
 | 
			
		||||
 | 
			
		||||
```sh
 | 
			
		||||
reuse spdx
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
@ -633,6 +633,7 @@ let g:ragtag_global_maps = 1
 | 
			
		||||
" vim-markdown-toc deletes text if the file is folded, use manual updates
 | 
			
		||||
let g:vmt_auto_update_on_save = 0
 | 
			
		||||
let g:vmt_dont_insert_fence = 1
 | 
			
		||||
let g:vmt_list_indent_text = "    "
 | 
			
		||||
 | 
			
		||||
let b:commentary_startofline = 1
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user