aboutsummaryrefslogtreecommitdiff
path: root/README.org
blob: c9544c58eee042d608c2747cc593b924114c7dfb (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
#+TITLE: Dotfiles
#+AUTHOR: Oreodave
#+DESCRIPTION: README for Dotfiles

* Preclude
My Dotfiles repository with configuration files for most of the applications I
use on a daily basis.
* Links
[[file:doom.d/][Emacs config]]

[[file:mpd/][MPD config]]

[[file:vimrc][Vim config]]

[[file:zshenv][ZSH config]]
* Tools
- Git: how...what are you doing without this?
- Emacs: Editor for everything, incredibly powerful. Is used with [[https://github.com/hlissner/doom-emacs][Doom Emacs]].
- Vim: Developed to be used with Tmux, lightning fast and pretty good.
- Tmux: Used in conjunction with Vim. Has bindings for quick switching between
  Vim windows and tmux panes, as well as full on vi bindings
- ZSH: Shell with amazing theme options as well as completion systems
- Pass: Password manager/generator which I strongly recommend
- Firefox: Best browser

* Dependencies
|-------------------------+----------------+------------------------|
| Dependency              |        Version | Link                   |
|-------------------------+----------------+------------------------|
| Vim                     |              8 | [[https://www.vim.org/download.php][Vim]]                    |
| Emacs                   |          26.2+ | [[https://www.gnu.org/software/emacs/download.html][Emacs]]                  |
| Tmux                    |           1.5+ | [[https://github.com/tmux/tmux][Tmux]]                   |
| Omnisharp Roslyn Server |         Latest | [[https://github.com/omnisharp/omnisharp-roslyn][Omnisharp]]              |
| Python                  | 3.6.8 and 2.7+ | [[https://www.python.org/downloads/][Python]]                 |
| Zeal                    |         0.6.0+ | [[https://zealdocs.org][Zeal]]                   |
| .NET Core               |         2.2.3+ | [[https://dotnet.microsoft.com/download][.NET]]                   |
| Fzf                     |         0.18.0 | [[https://github.com/junegunn/fzf][Fzf]]                    |
| cargo/rust              |         1.3.6+ | [[https://github.com/rust-lang/cargo/][Rust]]                   |
| fd                      |         7.3.0+ | [[https://github.com/sharkdp/fd][Fd]]                     |
| ripgrep                 |        11.0.1+ | [[https://github.com/BurntSushi/ripgrep][RipGrep]]                |
| tmuxinator (optional)   |           1.0+ | [[https://github.com/tmuxinator/tmuxinator][tmuxinator]]             |
|-------------------------+----------------+------------------------|

* How to use
Initialise an org file at the root of a project. Preferably initialise these org
files:
- README.org
- doc.org/notes.org/
- todos.org