Update LICENSE & README (wip)
This commit is contained in:
		
							parent
							
								
									ed36644143
								
							
						
					
					
						commit
						c4b7ac4337
					
				
							
								
								
									
										2
									
								
								LICENSE
									
									
									
									
									
								
							
							
						
						
									
										2
									
								
								LICENSE
									
									
									
									
									
								
							|  | @ -1,6 +1,6 @@ | |||
| The MIT License (MIT) | ||||
| 
 | ||||
| Copyright (c) 2016-2017 Henrik Lissner. | ||||
| Copyright (c) 2016-2019 Henrik Lissner. | ||||
| 
 | ||||
| Permission is hereby granted, free of charge, to any person obtaining | ||||
| a copy of this software and associated documentation files (the | ||||
|  |  | |||
							
								
								
									
										82
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										82
									
								
								README.md
									
									
									
									
									
								
							|  | @ -2,74 +2,30 @@ | |||
| 
 | ||||
| A tidy `$HOME` is a tidy mind. | ||||
| 
 | ||||
|  | ||||
| 
 | ||||
| These are my dotfiles, designed primarily for Arch Linux, MacOS and debian. They | ||||
| are my specific breed of madness, split into 2-level topics (e.g. `shell/zsh`) | ||||
| that strive for minimum `$HOME` presence (adhering to XDG standards where | ||||
| possible). | ||||
| 
 | ||||
| + wm: bspwm | ||||
| + shell: zsh | ||||
| + font: kakwafont | ||||
| + bar: polybar | ||||
| 
 | ||||
| ## Quick start | ||||
| 
 | ||||
| `bash <(curl -s https://raw.githubusercontent.com/hlissner/dotfiles/master/bootstrap.sh)` | ||||
| ```sh | ||||
| # Make sure your partitions are set up by this point | ||||
| git clone https://github.com/hlissner/dotfiles /etc/dotfiles | ||||
| /etc/dotfiles/deploy HOSTNAME   # installs nixos to /mnt | ||||
| ``` | ||||
| 
 | ||||
| ## Overview | ||||
| 
 | ||||
| ```sh | ||||
| # general | ||||
| bin/       # global scripts | ||||
| assets/    # wallpapers, sounds, screenshots, etc | ||||
| 
 | ||||
| # categories | ||||
| base/      # provisions my system with the bare essentials | ||||
| dev/       # relevant to software development & programming in general | ||||
| editor/    # configuration for my text editors | ||||
| misc/      # for various apps & tools | ||||
| shell/     # shell utilities, including zsh + bash | ||||
| config/ | ||||
| themes/ | ||||
| modules/ | ||||
|   audio/ | ||||
|   browser/ | ||||
|   desktop/ | ||||
|   dev/ | ||||
|   editors/ | ||||
|   gaming/ | ||||
|   graphics/ | ||||
|   misc/ | ||||
|   services/ | ||||
|   shell/ | ||||
|   video/ | ||||
| ``` | ||||
| 
 | ||||
| ## Dotfile management | ||||
| 
 | ||||
| ``` | ||||
| Usage: deploy [-acdlLit] [TOPIC...] | ||||
| 
 | ||||
|   -a   Target all enabled topics (ignores TOPIC args) | ||||
|   -c   Afterwards, remove dead symlinks & empty dot-directories in $HOME. | ||||
|        Can be used alone. | ||||
|   -d   Unlink and run `./_init clean` for topic(s) | ||||
|   -l   Only relink topic(s) (implies -i) | ||||
|   -L   List enabled topics | ||||
|   -i   Inhibit install/update/clean init scripts | ||||
|   -t   Do a test run; do not actually do anything | ||||
| ``` | ||||
| 
 | ||||
| e.g. | ||||
| + `deploy base/arch shell/{zsh,tmux}`: enables base/arch, shell/zsh & shell/tmux | ||||
| + `deploy -d shell/zsh`: disables shell/zsh & cleans up after it | ||||
| + `deploy -l shell/zsh`: refresh links for shell/zsh (inhibits init script) | ||||
| + `deploy -l`: relink all enabled topics | ||||
| + `deploy -L`: list all enabled topics | ||||
| 
 | ||||
| Here's a breakdown of what the script does: | ||||
| 
 | ||||
| ``` sh | ||||
| cd $topic | ||||
| if [[ -L $DOTFILES_DATA/${topic//\//.}.topic ]]; then | ||||
|     ./_init update | ||||
| else | ||||
|     ln -sfv $DOTFILES/$topic $DOTFILES_DATA/${topic//\//.}.topic | ||||
| 
 | ||||
|     ./_init install | ||||
|     ./_init link | ||||
| fi | ||||
| ``` | ||||
| 
 | ||||
| ## Relevant projects | ||||
| 
 | ||||
| + [DOOM Emacs](https://github.com/hlissner/doom-emacs) (pulled by `editor/emacs`) | ||||
| + [My vim config](https://github.com/hlissner/.vim) (pulled by `editor/{neo,}vim`) | ||||
|  |  | |||
		Loading…
	
		Reference in a new issue