From 8a7a868132977e55b7a4eaa1f25ae6bbed988d5b Mon Sep 17 00:00:00 2001 From: Marius Peter Date: Mon, 13 Sep 2021 22:50:01 -0700 Subject: Much-needed update to the README. --- README.org | 46 ++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 38 insertions(+), 8 deletions(-) diff --git a/README.org b/README.org index 6cf341c..3a6e869 100644 --- a/README.org +++ b/README.org @@ -7,19 +7,24 @@ 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: @@ -35,29 +40,54 @@ 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 + +* Main files & directories + + +** =early-init.el= + +This is the first editable file that GNU Emacs loads on startup. + ** =init.el= -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= +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. -** =blendoit/init-blendoit.org= + +** =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. -- cgit v1.2.3