README.md
changeset 1715 b4821d6701e5
parent 1687 3f69332472cb
child 1716 7724648509b6
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Sat Jan 30 23:37:26 2021 +0200
@@ -0,0 +1,41 @@
+
+# Oleksandr Gavenko's Emacs initialization script
+
+## Installation
+
+To install:
+
+    make install
+
+To download external packages:
+
+    make install-packages
+
+## Config files structure
+
+I use `~/.emacs.d/init.d` as main entry point for customization. That file load
+another files in such order:
+
+`~/.emacs.d/.emacs-autogen`
+:   Hold environment info discovered during installing. Automatically generated.
+
+`~/.emacs.d/.emacs-pre`
+:   For manually written customization (usually for updating load-path) which
+    can affect on `.emacs-my`. Will not be overridden on install.
+
+`~/.emacs.d/my/loaddefs.el`
+:   Definition for my modes autoload functions. Automatically generated.
+
+`~/.emacs.d/.emacs-custom`
+:   For storing customization's by Emacs itself. Some settings from this file can
+    effect on loaded Elisp files from .emacs-my. Will not be overridden on
+    install.
+
+`~/.emacs.d/.emacs-my`
+:   Here main customization's is placed.
+
+`~/.emacs.d/.emacs-post`
+:   For storing connection settings, passwords and enabling modes added to
+    load-path in `~/.emacs.d/.emacs-pre`. Will not be overridden on install.
+
+