summaryrefslogtreecommitdiff
path: root/README.org
blob: 3a6e8698caf78e2448b22fa2312dc15684b9b402 (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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
#+TITLE: GNU Emacs Configuration 
#+AUTHOR: Marius Peter
#+DATE: <2020-10-13 Tue>
#+SETUPFILE: ~/.emacs.d/templates/documents/default.org

Website is now live at [[http://smart-documents.org/][smart-documents.org]]!

* Installation


** GNU Emacs


*** Linux

Use your package manager.


*** Windows

Head on over to https://www.gnu.org/savannah-checkouts/gnu/emacs/download.html
and download yourself a /fresh/ copy of GNU Emacs.


** My distribution


*** Linux

Backup your current =~/.emacs.d= with the following command:

#+BEGIN_SRC shell
mv ~/.emacs.d ~/.emacs.d.bkp
#+END_SRC

Clone my configuration folder to your home directory:

#+BEGIN_SRC shell
cd ~
git clone https://github.com/Blendoit/.emacs.d.git
#+END_SRC


*** Windows

Download a =.zip= of the files in this repository. Then, extract the =.zip=, and
rename the extracted folder to =.emacs.d=. Place this folder in your home folder
(one level up from =Documents=, =Pictures= or =Desktop=).


* Main files & directories


** =early-init.el=

This is the first editable file that GNU Emacs loads on startup.


** =init.el=

This file's only purpose is to load my literate configuration
=blendoit/init-blendoit.org=.


** =custom.el=

All customization options available in Emacs' GUI that can be saved with
=Options - Save Options= are saved here. This is useful to fool around with GUI
customization options, without breaking our manually written code.


** =smart-documents.org=
   
This is my personal literate configuration file.


** =./meta=

Contains data specific to the device currently running Emacs, namely
where it should expect recent files, autosaved files, and projects'
locations.


** =./resources=

Contains files that you would copy-paste from one device to another,
if the second device has no internet access (common occurrence at
work?)


* Usage

  Each configuration file is commented.
Copyright 2019--2024 Marius PETER