Skip to content

My experience of using Emacs and customization and packages that I have tried.

Notifications You must be signed in to change notification settings

amolgawai/emacsadventures

Repository files navigation

emacsadventures - my adventure of setting up Emacs

                                                                             __                                  __
                                                                            /  |                                /  |
  ______   _____  ____    ______    _______   _______         ______    ____$$ | __     __  ______   _______   _$$ |_    __    __   ______    ______    _______
 /      \ /     \/    \  /      \  /       | /       |       /      \  /    $$ |/  \   /  |/      \ /       \ / $$   |  /  |  /  | /      \  /      \  /       |
/$$$$$$  |$$$$$$ $$$$  | $$$$$$  |/$$$$$$$/ /$$$$$$$/        $$$$$$  |/$$$$$$$ |$$  \ /$$//$$$$$$  |$$$$$$$  |$$$$$$/   $$ |  $$ |/$$$$$$  |/$$$$$$  |/$$$$$$$/
$$    $$ |$$ | $$ | $$ | /    $$ |$$ |      $$      \        /    $$ |$$ |  $$ | $$  /$$/ $$    $$ |$$ |  $$ |  $$ | __ $$ |  $$ |$$ |  $$/ $$    $$ |$$      \
$$$$$$$$/ $$ | $$ | $$ |/$$$$$$$ |$$ \_____  $$$$$$  |      /$$$$$$$ |$$ \__$$ |  $$ $$/  $$$$$$$$/ $$ |  $$ |  $$ |/  |$$ \__$$ |$$ |      $$$$$$$$/  $$$$$$  |
$$       |$$ | $$ | $$ |$$    $$ |$$       |/     $$/       $$    $$ |$$    $$ |   $$$/   $$       |$$ |  $$ |  $$  $$/ $$    $$/ $$ |      $$       |/     $$/
 $$$$$$$/ $$/  $$/  $$/  $$$$$$$/  $$$$$$$/ $$$$$$$/         $$$$$$$/  $$$$$$$/     $/     $$$$$$$/ $$/   $$/    $$$$/   $$$$$$/  $$/        $$$$$$$/ $$$$$$$/

Introduction

This is my adventure of setting up emacs for everyday use. I was inspired by Spacemacs and super-emacs. My goals for the configuration are

  • Asthetic - an eye pleasing emacs
  • Fast and productive
  • emacsy - keep emacs behavior and add only when necessary, except now added EVIL mode

After I started learning Vim, I have switched to EVIL mode. After this I (re) discovered doom-emacs which is almost on the same lines as my needs but is a much more advanced emacs “distribution”. I am currently evaluating the same for long term usage.

A very similar config I found is M-EMACS

How To Install

If you want to use my configuration, following are the steps

  • Install Source Code Pro Fonts
  • Clone this repository
  • Link the resulting directory from your .emacs.d
  • Add following line to your init.el (load "~/.emacs.d/emacsadventures/loadMyConfig.el")
  • Start emacs
  • look for any errors as some packages may fail to install
  • Install the failed packages manually by running following M-x packages-install-package
  • Install all-the-icons by running M-x all-the-icons-install-fonts
  • On windows, you might need to install them from a resulting directory
  • Restart emacs and begin your adventure

How To Customize

You can customize the configuration the usual emacs way.

  • Start in the loadMyConfig.el
  • comment out sections which you do not want
  • Add yout personal configuration in the ‘private’ directory
  • The personal configuration is loaded as a last step

User Guide [Needs work]

Keybinding Quickref - This is loaded in every session - search for buffer named ”emacsadventures-keyref

Please find the user guide at User Guide

Cheatsheets

All the important cheatsheets are located in the quickref directory

Feedback

I would be very pleased if you give me feedback to improve this configuration. I will try to improve as I go along using it. Thank You.

TODOs

-[ ] Move setq from :config/:init to :custom as is the suggestion for use-package

Tips and Tricks

If you are facing problems for vterm on M1 macs after update, following is a solution. From - akermu/emacs-libvterm#593 (comment)

$ cd ~/.config/emacs/.local/straight/build-29.1/vterm
$ rm -rf build
$ mkdir build
$ arch -arm64 cmake -B build
$ arch -arm64 cmake --build build

$ file vterm-module.so
vterm-module.so: Mach-O 64-bit bundle arm6

Further Research

Furhter research for improvements

About

My experience of using Emacs and customization and packages that I have tried.

Resources

Stars

Watchers

Forks

Packages

No packages published