README.rst
author Oleksandr Gavenko <gavenkoa@gmail.com>
Sat, 02 Jan 2021 22:42:24 +0200
changeset 1687 3f69332472cb
parent 1237 a194c21bc9d2
permissions -rw-r--r--
Added Make target to preinstall packages from ELPA.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
749
a8d71dd0fbd5 Convert documentation files to RST syntax.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 386
diff changeset
     1
.. -*- coding: utf-8 -*-
a8d71dd0fbd5 Convert documentation files to RST syntax.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 386
diff changeset
     2
a8d71dd0fbd5 Convert documentation files to RST syntax.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 386
diff changeset
     3
=====================
a8d71dd0fbd5 Convert documentation files to RST syntax.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 386
diff changeset
     4
 'dot-emacs' README.
a8d71dd0fbd5 Convert documentation files to RST syntax.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 386
diff changeset
     5
=====================
a8d71dd0fbd5 Convert documentation files to RST syntax.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 386
diff changeset
     6
.. contents::
12
fb11a9de5ab3 Добавил коментарии по инсталляции файлов настроек.
Oleksander Gavenko <gavenko_a@3g.ua>
parents:
diff changeset
     7
1237
a194c21bc9d2 Update docs for new file hierarchy.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 749
diff changeset
     8
:Author: Oleksandr Gavenko <gavenkoa@gmail.com>
42
04fd7747bc49 Update copyright notice.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 13
diff changeset
     9
1687
3f69332472cb Added Make target to preinstall packages from ELPA.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1237
diff changeset
    10
Installation
3f69332472cb Added Make target to preinstall packages from ELPA.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1237
diff changeset
    11
===
3f69332472cb Added Make target to preinstall packages from ELPA.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1237
diff changeset
    12
3f69332472cb Added Make target to preinstall packages from ELPA.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1237
diff changeset
    13
To install::
3f69332472cb Added Make target to preinstall packages from ELPA.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1237
diff changeset
    14
3f69332472cb Added Make target to preinstall packages from ELPA.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1237
diff changeset
    15
  make install
3f69332472cb Added Make target to preinstall packages from ELPA.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1237
diff changeset
    16
3f69332472cb Added Make target to preinstall packages from ELPA.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1237
diff changeset
    17
To download external packages::
3f69332472cb Added Make target to preinstall packages from ELPA.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1237
diff changeset
    18
3f69332472cb Added Make target to preinstall packages from ELPA.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1237
diff changeset
    19
  mymake install-packages
3f69332472cb Added Make target to preinstall packages from ELPA.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1237
diff changeset
    20
3f69332472cb Added Make target to preinstall packages from ELPA.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1237
diff changeset
    21
Config files structure
3f69332472cb Added Make target to preinstall packages from ELPA.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1237
diff changeset
    22
===
46
773ac573338d Update content.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 42
diff changeset
    23
1237
a194c21bc9d2 Update docs for new file hierarchy.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 749
diff changeset
    24
I use ``~/.emacs.d/init.d`` as main entry point for customisation. Tha file load
a194c21bc9d2 Update docs for new file hierarchy.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 749
diff changeset
    25
anoth files in such order:
46
773ac573338d Update content.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 42
diff changeset
    26
1237
a194c21bc9d2 Update docs for new file hierarchy.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 749
diff changeset
    27
  ``~/.emacs.d/.emacs-autogen``
a194c21bc9d2 Update docs for new file hierarchy.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 749
diff changeset
    28
    Hold environment info discovered during installing. Automatically generated.
a194c21bc9d2 Update docs for new file hierarchy.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 749
diff changeset
    29
  ``~/.emacs.d/.emacs-pre``
a194c21bc9d2 Update docs for new file hierarchy.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 749
diff changeset
    30
    For manually written customisation (usually for updating load-path) which
a194c21bc9d2 Update docs for new file hierarchy.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 749
diff changeset
    31
    can affect on ``.emacs-my``. Will not be overridden on install.
a194c21bc9d2 Update docs for new file hierarchy.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 749
diff changeset
    32
  ``~/.emacs.d/my/loaddefs.el``
a194c21bc9d2 Update docs for new file hierarchy.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 749
diff changeset
    33
    Definition for my modes autoload functions. Automatically generated.
a194c21bc9d2 Update docs for new file hierarchy.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 749
diff changeset
    34
  ``~/.emacs.d/.emacs-custom``
a194c21bc9d2 Update docs for new file hierarchy.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 749
diff changeset
    35
    For storing customisations by Emacs itself. Some settings from this file can
a194c21bc9d2 Update docs for new file hierarchy.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 749
diff changeset
    36
    effect on loaded elisp files from .emacs-my. Will not be overridden on
a194c21bc9d2 Update docs for new file hierarchy.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 749
diff changeset
    37
    install.
a194c21bc9d2 Update docs for new file hierarchy.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 749
diff changeset
    38
  ``~/.emacs.d/.emacs-my``
a194c21bc9d2 Update docs for new file hierarchy.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 749
diff changeset
    39
    Here main customisations is placed.
a194c21bc9d2 Update docs for new file hierarchy.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 749
diff changeset
    40
  ``~/.emacs.d/.emacs-post``
a194c21bc9d2 Update docs for new file hierarchy.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 749
diff changeset
    41
    For storing connection settings, passwords and enabling modes added to
a194c21bc9d2 Update docs for new file hierarchy.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 749
diff changeset
    42
    load-path in ``~/.emacs.d/.emacs-pre``. Will not be overridden on install.
749
a8d71dd0fbd5 Convert documentation files to RST syntax.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 386
diff changeset
    43
1237
a194c21bc9d2 Update docs for new file hierarchy.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 749
diff changeset
    44