Files
emacs-dotfiles/README.md
Vladislav Slobodenyuk c0a6d46af8 README rework.
Installed markdown-mode, changed the screenshot and updated the README.md to my
own.
2025-01-23 10:42:10 +09:00

22 lines
1.6 KiB
Markdown

# iamtoaster dotfiles
![License](https://img.shields.io/github/license/jamescherti/be-quiet.el)
![](.images/made-for-gnu-emacs.svg)
My dotfiles are based on the [minimal-emacs.d](https://github.com/jamescherti/minimal-emacs.d) project. The changes to the source repository will sometimes be synced to this repository, with my own changes being rebased on top.
![](.images/screenshot.png)
The original repository contains a lot of useful info, so do check it out.
## Dotfiles setup
Author of [minimal-emacs.d](https://github.com/jamescherti/minimal-emacs.d) suggests putting (almost) everything into the post-init.el file, which I simply do not agree with. I am used to using plug-in files, with the main one only having the bare minimum of content.
As such, post-init.el file only contains the minimal setup code, and at the end loads the files in the `.config.d` folder, in alphanumeric order. In those plug-in files the real magic happens. All the files are heavily documented, with mostly self-explanatory names, so I think it will be redundant to list them here. See the files in `config.d` directory for more.
## Repository setup
This section contains a bit of information on how to setup this git repository after you cloned it (in case you want to modify it, ignore otherwise).
You will need to add a new origin, usually called just 'upstream', that points to the original [minimal-emacs.d](https://github.com/jamescherti/minimal-emacs.d) repository. Then, to pull in any new updates, you will have to pull them form there with a --rebase flag. This will ensure that any modifications to the original repository will be applied on top.