diff options
| author | LLoyderino <adrijan.bjedov@gmail.com> | 2025-09-13 13:57:35 +0200 |
|---|---|---|
| committer | LLoyderino <adrijan.bjedov@gmail.com> | 2025-09-13 13:57:59 +0200 |
| commit | abbd1f954eea55ac571462d37f8f7cf0c8b5fa95 (patch) | |
| tree | c773d3a3fbebf10e3cecfb4614dfd349e4c9c1ad | |
| parent | 731f42ac4c862e939af8f8b5ab345b3a44f36956 (diff) | |
Rewrote README.md to include the dependencies needed to use the config
| -rw-r--r-- | README.md | 24 |
1 files changed, 19 insertions, 5 deletions
@@ -2,11 +2,25 @@ This is my emacs configuration. It aims to be *simple* and *lean* -## Notes +## Requirements -This setup is tested on Emacs 30, this means some packages are already built-in, such as: +### Emacs version -- `use-package` -- `pdf-tools` with `emacsPackages.pdf-tools` +I run this config on Emacs 30, which means some packages are already built-in. On older +version you might require to install them separately. -Additionally the theme custom module assumes you are running Gnome +Some examples include: + +- flymake +- project.el +- treesitter +- use-package + +### External dependencies + +The following programs need to be installed externally in order for everything to work: + +- [Git](https://git-scm.com) +- [Gnome](https://www.gnome.org/) - (alternatively change `theme.el` to match your DE/WM) +- [aspell](http://aspell.net/) - (alternatively just use ispell) +- [epdfinfo server](https://github.com/vedang/pdf-tools?tab=readme-ov-file#installing-the-epdfinfo-server) - Needed to run `pdf-tools` |