emacs-config/README.org

30 lines
845 B
Org Mode

#+TITLE: ReadMe: Emacs Config
* What is this?
This is the writer's personal configuration for Emacs.
* How to use this config?
This configuration works best on a GNU/Linux Platform, other platforms are untested.
** Dependencies
Obviously, a full Emacs distribution needs to be installed.
Other external dependencies is (usually) specified in their configuration.
** Installation
First, download this configuration
#+begin_src sh
mkdir -p $HOME/.config
git clone "https://gitlab.com/telosama/emacs-config.git" $HOME/.config/emacs
#+end_src
Then, run Emacs.
And done!
* Philosophy
- keep it simple
- prefer built-in packages and programs than external ones
- These are not rules, they are more of a suggestions/guidelines.
* Support/Contribution
Improvement into this config is very welcomed, as many things still needs improvement