From c4b7ac4337a3150e40aba0279ac92b835c1682d0 Mon Sep 17 00:00:00 2001 From: Henrik Lissner Date: Tue, 6 Aug 2019 13:57:38 -0400 Subject: [PATCH] Update LICENSE & README (wip) --- LICENSE | 2 +- README.md | 82 +++++++++++++------------------------------------------ 2 files changed, 20 insertions(+), 64 deletions(-) diff --git a/LICENSE b/LICENSE index 5b1a7fdf..02b93bee 100644 --- a/LICENSE +++ b/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 diff --git a/README.md b/README.md index 1db42909..43cd563c 100644 --- a/README.md +++ b/README.md @@ -2,74 +2,30 @@ A tidy `$HOME` is a tidy mind. -![Oct-2017 Screenshot of Arch Linux](assets/screenshots/OCT2017.png) - -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`)