aboutsummaryrefslogtreecommitdiff
path: root/README.org
blob: 8450ffd7b6271569282f18608a1858ec3bb8583d (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
#+TITLE: dotfiles
#+AUTHOR: Miquel Sabaté Solà
#+EMAIL: mikisabate@gmail.com

Download everything by performing the following command (notice the =--recursive= flag):

#+BEGIN_SRC bash
$ git clone --recursive https://github.com/mssola/dotfiles.git
#+END_SRC

To install everything just run the =install.sh= script. Use this at your own risk ;)

** GNU Emacs

See [[./.emacs.d/README.org][.emacs.d/README.org]]

** Runtime dependencies

There are lots of runtime dependencies that matter to Vim, GNU Emacs, etc. In openSUSE (probably similar in your distribution) they can be solved like this:

#+BEGIN_SRC sh
$ 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
#+END_SRC

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.

This is by no means an exhaustive list. Feel free to report me missing dependencies on this repo.

** 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:

#+BEGIN_SRC text
Copyright (C) 2014-2019 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/>.
#+END_SRC