diff options
Diffstat (limited to 'README.adoc')
| -rw-r--r-- | README.adoc | 33 |
1 files changed, 13 insertions, 20 deletions
diff --git a/README.adoc b/README.adoc index 1bd6ab7..6a1dbf0 100644 --- a/README.adoc +++ b/README.adoc @@ -6,26 +6,10 @@ Mitsuo My configuration settings and config files for various programs. -== TODO - -* Create script that compares installed vs repository dotfiles - - == Usage -To run installation script do - -[source, sh] ----- -# Modify install.sh according to your needs, then -chmod u+x install.sh -./install.sh ----- - -Default behaviour is to copy (instead of sym-linking) the dotfiles to their -appropiate locations. - -*Some dotfiles require manual installation.* +There is an installation script but it is work in progress. Currently it can +only install some of the config files. == Description @@ -33,9 +17,8 @@ appropiate locations. The following applications are configured: Vim:: Nothing fancy, "the essential" and just some custom mappings +NeoVim:: Settings, mappings, custom commands, and plugins Bash:: Vim input, aliases, XDG variables, git prompt -Git:: https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup[ - Name, email, difftool] Ideavimrc:: Some config for Vim plugin for IntelliJ and Pycharm Xorg:: Enviroment for Xorg. Set fcitx env. var., start KDE Plasma @@ -62,6 +45,16 @@ Some files are included in the installation script //// +== Installation + +[source, sh] +---- +mkdir -p ~/mahcode +git clone --recurse-submodules https://github.com/zazke/dotfiles +cd dotfiles +---- + + == Files currently requiring manual installation *st*: For emoji support: Install https://st.suckless.org/patches/font2/[font2] |