My Emacs Config

Emacs Config preconfigured for org-roam(including server), org-brain, pdftools and a range of bibleography and note-taking tools.

Prerequisites

Before you begin, ensure you have met the following requirements:

• You have installed the latest version of Emacs
• Windows 10 (64bit) or Kali(Linux), should work on other OS's but those are the ones I've tested.
• (Reccomended) Msys2 which I believe is a compatiblity layer, though if I'm honest I'm not entirely sure.
• (Optional) A TeX distribution, I use TeXLive as it's cross platform but it's completely upto you. Having a TeX processor allows you to export Org-notes to TeX or PDF while adding typsetting support.

Installing My Emacs Config

Clone or download this repository

Then to install the repository, follow these steps:

Windows:

1. Create a symlink from where emacs expects to find the .emacs file to where you've placed it, or move it to that expected location.

Expected location(Vista and up):

C:/Users/<Username>/AppData/Roaming/.emacs

Symlink (run in command prompt):

mklink C:\Users\<username>\AppData\Roaming\.emacs 

2. Open the .emacs file with a text editor and change things to match your filestructure, things you need to change will are commented "MUST" "SHOULD" & "MAY", see also the aesthetics-example.el
3. Enter <Win>+R + "C:\Program Files\Emacs\bin\runemacs.exe" + RET
4. Use-package will start installing things: Go make a cup of tea/coffee
5. Delete org-brain.elc (in .emacs.d/elpa/org-brain-xxxx/), this fixes a known issue
6. Right-click and select edit on .emacs.d/win/org-protocols.reg and check the path is correct then double-click the program to run.
7. Done :)

Linux:

1. Create a symlink from where emacs expects to find .emacs to where you've placed it, or move it to the correct location.

Expected location:

/home/<username>/.emacs

Symlink

ln -s /path/to/this/repo/.emacs ~/.emacs

2. Open the .emacs file with a text editor and change things to match your filestructure, things you need to change will are commented "MUST" "SHOULD" & "MAY", see also the aesthetics-example.el
3. Enter <Win> + "Emacs" + RET
4. Use-package will start installing things: Go make a cup of tea/coffee
5. Delete org-brain.elc (in .emacs.d/elpa/org-brain-xxxx/), this fixes a known issue
6. Done :)

Contributors

Thanks all the people who provided the guides howto's and software to make building a config that works for me possible, to name a few:

• If I've copied any code from anywhere I've linked to it directly above the code in a comment
• @nobiot 🐛 Zero-to-Emacs-and-Org-Roam
• @scottydocs 📖

Contact

If you want to contact me you can reach me at [email protected].