emacs-config/README.org

46 lines
1.5 KiB
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.
*** Mail
For RMail to work, a mail syncer like mbsync needs to be installed.
And for emacs RMail to be able to read mbsync maildir format, GNU Mailutils is also needed to be installed
*** Language Servers
For Language servers to work, the language servers needs to be installed separately, for example, in Fedora Linux, the required language servers can be installed by running the command below
#+begin_src sh
sudo dnf install clang-tools-extra npm cargo go
pip install -U pyright
npm i --save -g typescript-language-server typescript vscode-html-languageservice
cargo install texlab
go install golang.org/x/tools/gopls@latest
#+end_src
** Installation
First, download this configuration
#+begin_src sh
mkdir -p $HOME/.config
git clone "https://git.telosama.xyz/iang/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