README.org 2.27 KB
Newer Older
Jay Kamat's avatar
Jay Kamat committed
1
* MechJay [[https://gitlab.com/jgkamat/dotfiles/pipelines][file:https://gitlab.com/jgkamat/dotfiles/badges/master/pipeline.svg?style=shield]]
Jay Kamat's avatar
Jay Kamat committed
2

Jay Kamat's avatar
Jay Kamat committed
3
This is the source repository for the MechJay Automation System.
Jay Kamat's avatar
Jay Kamat committed
4

Jay Kamat's avatar
Jay Kamat committed
5
6
While not perfect, this system saves many hours of time per day, both by
improving efficiency and by simply being a more pleasant environment to work in.
Jay Kamat's avatar
Jay Kamat committed
7

Jay Kamat's avatar
Jay Kamat committed
8
9
MechJay is split up into individual stow modules, so you can apply configuration
for individual applications at a time.
Jay Kamat's avatar
Jay Kamat committed
10
11
12

* Install

Jay Kamat's avatar
Jay Kamat committed
13
MechJay uses [[https://www.gnu.org/software/stow/][GNU Stow]]. Edit the [[file:.stowrc][stowrc]] file to point to your home directory and:
Jay Kamat's avatar
Jay Kamat committed
14
15

#+BEGIN_SRC shell
Jay Kamat's avatar
Jay Kamat committed
16
stow */
Jay Kamat's avatar
Jay Kamat committed
17
#+END_SRC
Jay Kamat's avatar
Jay Kamat committed
18

Jay Kamat's avatar
Jay Kamat committed
19
20
21
You can add ~--adopt~ to the command to overwrite existing files (by bringing
them into this repo), or you can specify only the directories you wish by
listing them instead of using the glob.
22

Jay Kamat's avatar
Jay Kamat committed
23
To delete broken symlinks (maybe from a migration) run this:
Jay Kamat's avatar
Jay Kamat committed
24

Jay Kamat's avatar
Jay Kamat committed
25
#+BEGIN_SRC shell
Jay Kamat's avatar
Jay Kamat committed
26
find -L ${HOME} -maxdepth 0 -type l -delete
Jay Kamat's avatar
Jay Kamat committed
27
28
#+END_SRC

Jay Kamat's avatar
Jay Kamat committed
29
30
* Programs

Jay Kamat's avatar
Jay Kamat committed
31
32
Here are a list of notable applications used. It's probably outdated.

Jay Kamat's avatar
Jay Kamat committed
33
34
35
36
| Category      | Application                    |
|---------------+--------------------------------|
| OS            | bedrock {debian,fedora,gentoo} |
| WM            | awesome                        |
Jay Kamat's avatar
Jay Kamat committed
37
| Web           | firefox + tridactyl            |
Jay Kamat's avatar
Jay Kamat committed
38
39
40
41
42
43
44
45
46
| Editor        | emacs + evil                   |
| File Browsing | dired/shell                    |
| irc           | circe                          |
| PDF           | zathura                        |
| Images        | pqiv                           |
| Video         | mpv                            |
| Shell         | zsh/shell.el/eshell            |
| Music         | pianobar.el                    |
| Email         | mu4e                           |
47
| Art           | Krita                          |
Jay Kamat's avatar
Jay Kamat committed
48

Jay Kamat's avatar
Jay Kamat committed
49
* Screenshots
Jay Kamat's avatar
Jay Kamat committed
50
Here are some screenshots so you can get a feel for MechJay. They're probably outdated.
Jay Kamat's avatar
Jay Kamat committed
51
** Clean
Jay Kamat's avatar
Jay Kamat committed
52
[[https://i.imgur.com/ov9u71A.jpg]]
Jay Kamat's avatar
Jay Kamat committed
53
** qutebrowser
Jay Kamat's avatar
Jay Kamat committed
54
[[https://i.imgur.com/3kVis02.png]]
Jay Kamat's avatar
Jay Kamat committed
55
** Terminals
Jay Kamat's avatar
Jay Kamat committed
56
[[https://i.imgur.com/NfiDcRE.jpg]]
Jay Kamat's avatar
Jay Kamat committed
57
** Emacs
Jay Kamat's avatar
Jay Kamat committed
58
[[https://i.imgur.com/XK0xGR2.jpg]]
59
60
** Bedrock
[[https://i.imgur.com/hP0kNOG.png]]
Jay Kamat's avatar
Jay Kamat committed
61
62
63
64
* License

Everything is GPLv3 unless stated otherwise in the file or directory.
There are a few GPLv2 components in here as well.