aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 0c007af1bbc30aab2ac97981e7524563bfd2b4c9 (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
65
66
67
68
69
70
71
72
73
74
75
76
# dotfiles [![Build Status](https://travis-ci.org/mssola/dotfiles.svg?branch=master)](https://travis-ci.org/mssola/dotfiles)

To automatically install everything, just execute the `install.sh` script.
Take a look at this script since it might perform some actions that are
not of your satisfaction. Anyways, by default this script takes care of
initializing and updating submodules (in my case, I keep the vundle repo as
a submodule). Vim plugins will also get installed automatically.

And that's about it. Use this at your own risk ;)

## GNU Emacs

**NOTE**: these instructions are outdated, I'll update them whenever I can.

For the configuration of Emacs I'm trying out using symlinks instead of copying
files into the right places. For this reason, for now I'm not providing an
automatical way to install everything (this is left to be done in the near
future). The `emacs/init.el` and `emacs/gtkrc` files should be symlinked into
`~/.emacs.d`.

I run GNU Emacs in daemon mode, but I don't use systemd for that. Instead, in
the `i3/config` file you'll see that I'm using `-a ""` as an argument of
`emacsclient`. This instructs `emacsclient` to spawn a new server if there
isn't one already. This means that the first time around it will take some
time, but in the next time everything will be alright.

Last but not least, I'm using my customized `soria` color theme. This theme is
unfortunately not available in any way other than Github. Therefore, you should
clone it yourself in https://github.com/mssola/soria, and add it into
the `~/.emacs.d` directory.

## Runtime dependencies

There are some runtime dependencies that matter to either Vim or Emacs. In
openSUSE (probably similar in your distribution) they can be solved like this:

```
$ go get -u golang.org/x/tools/cmd/goimports
$ go get -u github.com/rogpeppe/godef
$ go get -u github.com/dougm/goflymake
$ go get -u github.com/nsf/gocode
$ sudo zypper in spell
```

Also, in GNU Emacs the markdown mode requires a markdown-to-HTML converter. There
are multiple options, but for me `calibre` seems to work just fine.

## Weechat certificates

For connecting to OFTC I'm using my own SSL certificates. OFTC has good
documentation on how to do this [here](https://www.oftc.net/NickServ/CertFP/).

## License

Every file is licensed under the GPLv3+ unless stated otherwise. I've tried to
mention every major influence on my `dotfiles`, but most surely I've forgotten
to add some people. If you feel like you should be mentioned somewhere in my
config files, please send me an email. You can find the full license in the
`LICENSE` file and below:

```
Copyright (C) 2014-2016 Miquel Sabaté Solà <mikisabate@gmail.com>

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
```