summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 22e6df1405847b8e75d8250a37130626922d5cb2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# dotfiles

Personal configuration files.  Currently a mess, because I avoided adding the
leading dot in directory and file names, and decided to organize files per
program.  In the future, I want to have the files as-they-are in the home
directory.  There'll 2 (or 3) "base" directories: `public`, `sensitive`
(non-secret, but also non-public, e.g., gnupg and sshd configuration files), and
`secret` (in case there are config files that contain secret data (very bad
practice)).  When this is implemented, installation is achieved by sym-linking
directories or files.


## Usage

There is an installation script but it is work in progress.  Currently it can
only install some of the config files.


## Description 

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
* Ideavimrc: Some config for Vim plugin for IntelliJ and Pycharm
* Xorg: Enviroment for Xorg.  Set fcitx env. var., start KDE Plasma

<!-- TODO: finish this list -->


```
Some files are included in the installation script 

 profile                             sh config
 bashrc                              bash "run commands"
 bash_aliases
 inputrc                             vim input for bash
 vim/fun.vim                         some vim functions
 vim/vimrc                           vim "run commands"
 extra/newdebian                     my debian/KDE Pasma 5 conf
 extra/qtcurvetestsettings.qtcurve     
 extra/20-libinput.conf              enable touchpad functionality
                                     (x220 specific)
 
 git/                                Git config files
 other/                              Other config files
 other/ideavimrc                     ~/.ideavimrc (Pycharm)
```


## Installation

```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]
and https://aur.archlinux.org/packages/libxft-bgra[libxft-bgra]