summaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorBlendoit <blendoit@gmail.com>2020-07-23 19:34:52 -0700
committerBlendoit <blendoit@gmail.com>2020-07-23 19:34:52 -0700
commit8dbeb1609c2e5511270b046c10fcaeed3b5b4555 (patch)
treea732045de20de795b00e42ab2d2638abe8beab31 /README.org
parent6fc2d436a9d9a4e33e23bba67e9be7db8cc3bbdd (diff)
Dashboard and README!
Diffstat (limited to 'README.org')
-rw-r--r--README.org50
1 files changed, 37 insertions, 13 deletions
diff --git a/README.org b/README.org
index 76c12e2..2776486 100644
--- a/README.org
+++ b/README.org
@@ -1,40 +1,64 @@
#+TITLE: GNU Emacs Configuration
#+AUTHOR: Marius Peter
-#+DATE: <2020-07-20 Mon>
+#+DATE: <2020-07-23 Thu>
+#+SETUPFILE: ~/org/templates/documents/personal.org
* Installation
+
+** GNU Emacs
+
+*** Linux
+
+Use your package manager.
+
+/Use Arch Linux. Dunaát make me say it twice./
+
+*** 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
+*** Linux
Backup your current =~/.emacs.d= with the following command:
-#+BEGIN_SRC: emacs-lisp
+#+BEGIN_SRC shell
mv ~/.emacs.d ~/.emacs.d.bkp
#+END_SRC
Clone my configuration folder to your home directory:
-#+BEGIN_SRC: emacs-lisp
+#+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 it in your home
+folder (one level up from =Documents=, =Pictures= or =Desktop=).
+
* Main Files
** =init.el=
- - This file's only purpose is to load my literate configuration.
+This is the first editable file that GNU Emacs loads on startup. This file's
+only purpose is to load my literate configuration =blendoit/init-blendoit.org=.
+
+** =init-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.
** =blendoit/init-blendoit.org=
- - Load my personal literate configuration files.
-
-** =blendoit/custom-file.el=
-
- - By default, 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.
+This is my personal literate configuration files.
* Usage
Copyright 2019--2024 Marius PETER