aboutsummaryrefslogtreecommitdiff
path: root/README.org
blob: 4a127570b4488baf1c88e34faa5859ceca6de375 (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
<p align="center">
  <a href="https://github.com/mssola/dotfiles/actions?query=workflow%3Aci" title="CI status for the main branch"><img src="https://github.com/mssola/dotfiles/workflows/ci/badge.svg" alt="Build Status for main branch" /></a>
  <a href="http://www.gnu.org/licenses/gpl-3.0.txt" rel="nofollow"><img alt="License GPL 3" src="https://img.shields.io/badge/license-GPL_3-blue.svg" style="max-width:100%;"></a>
</p>

---

These are my personal dotfiles, use them at your own risk! You can 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.

** GNU Emacs

I am using [[https://github.com/hlissner/doom-emacs][Doom Emacs]], see [[./.doom.d][.doom.d/README.org]]. For runtime dependencies just run:

#+BEGIN_SRC sh
$ doom doctor
#+END_SRC

This will give you everything you need to get right for my configuration.

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