README.org

Doom Emacs Private Configurations

Table of Content

• Introduction
  • How to Install
    • Setup Script
  • Directory Structure
  • Dependencies
    • Mac OS
• Workflow
  • Get Things Done
    • Configurations

Introduction

Doom Emacs is an awesome Emacs configuration that is easily extendable. This repository contains my configurations working on top of the Doom Emacs develop branch.

How to Install

1. Follow the instructions on Doom installation. I have only used this on Mac so far. a. I use Emacs mac-port as primary on Mac OS.
2. Clone this repository in ~/.config/doom or ~/.doom.d or other paths specified by echo $DOOMDIR.
3. Make sure to add ~/.emacs.d/bin to your $PATH.

   In fish, you can write the following and forget about it.

   fish_add_path ~/.config/emacs/bin
       

   Otherwise, add it to your bash profile.

4. Make sure you run doom sync every time the configurations changed. You can also do SPC h r r inside Emacs to change the configuration interactively.
5. Upgrade Doom regularly by running doom up.

Setup Script

This is a work-in-progress installation script.

# Install Doom Emacs by hlissner
git clone https://github.com/hlissner/doom-emacs ~/.config/emacs

# Install these configurations
git clone https://github.com/ashkan-leo/.doom.git ~/.config/doom/

# sync the configs
~/.emacs.d/bin/doom sync

# If you know Emacs won't be launched from your shell environment (e.g. you're
# on macOS or use an app launcher that doesn't launch programs with the correct
# shell) then create an envvar file to ensure Doom correctly inherits your shell
# environment.
~/.emacs.d/bin/doom env

# Lastly, install the icon fonts Doom uses:
emacs --batch -f all-the-icons-install-fonts

Directory Structure

I assumes numerous directories already exist – mainly for org-mode related functionalities:

Directory	Purpose	Default Path
leot/root-bib-directory	bib files synced with Zotero	~/Documents/Library/bib/
org-gtd-files-directory	org files for GTD workflow	~/Documents/gtd/

Dependencies

• Emacs
• Git
• ripgrep
• coreutils
• fd
• clang

Mac OS

• xcode CLI tools

Workflow

Get Things Done

Get Things Done (GTD) is the task management workflow in Pip Boy.

Configurations

Files & Directories

Directory	Purpose	Default Path
leot/root-bib-directory	bib files synced with Zotero	~/Documents/Library/bib/
org-gtd-files-directory	org files for GTD workflow	~/Documents/gtd/