emacs-files/README.org

58 lines
2.1 KiB
Org Mode
Raw Permalink Normal View History

2021-03-07 18:16:32 +00:00
* My Emacs Configuration
2019-05-09 23:19:48 +00:00
This is my Emacs configuration. It's been written and rewritten and
2022-01-06 16:34:19 +00:00
refactored and migrated and changed and updated since the 1990s.
2019-05-09 23:19:48 +00:00
2019-05-09 23:23:48 +00:00
I keep this setup in git because I like to keep it up to date across
all the computers I use — work laptop, home workstation, home laptop,
development servers, etc.
A lot of this stuff is pretty specific to my personal needs, but feel
free to steal ideas.
2021-03-07 18:16:32 +00:00
** Structure
2019-05-09 23:23:48 +00:00
2019-07-12 02:54:49 +00:00
My Emacs configuration is kept in *Literate Configuration* style.
This means that my configuration is a human-readable document that
puts comments first, and embeds the actual configuration elisp as code
snippets.
2022-01-06 16:34:19 +00:00
The main file is called [configuration.org](configuration.org), and is
in =org-mode= format.
2019-07-12 02:54:49 +00:00
2022-01-06 16:34:19 +00:00
Files found in =~/.emacs.d/local= (if it exists) are ignore by Git,
but added to the load path.
2019-07-12 02:54:49 +00:00
2022-01-06 16:34:19 +00:00
** Usage
2019-05-09 23:19:48 +00:00
2022-01-06 16:34:19 +00:00
If you already have an .emacs.d directory, make a backup!
2019-05-09 23:19:48 +00:00
2022-01-06 16:34:19 +00:00
: $ mv -f ~/.emacs.d ~/.emacs.d.OLD
2019-11-04 16:30:12 +00:00
2022-01-06 16:34:19 +00:00
Then, simply clone the project.
2019-11-04 16:30:12 +00:00
2021-03-07 18:16:32 +00:00
: $ git clone git@github.com:sethm/emacs-files.git ~/.emacs.d
2019-07-12 02:54:49 +00:00
2021-03-07 18:16:32 +00:00
** License
2019-05-09 23:19:48 +00:00
2022-01-06 16:34:19 +00:00
Copyright 19952022, Seth J. Morabito <web@loomcom.com>
2019-05-09 23:19:48 +00:00
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.