Skip to content

Latest commit

 

History

History
114 lines (86 loc) · 3.02 KB

README.md

File metadata and controls

114 lines (86 loc) · 3.02 KB
Raw

GNU Emacs / N Λ N O (developers edition)

GNU Emacs / N Λ N O (developers edition) is a set of configuration files for GNU Emacs based on nano-emacs such as to provide a nice and consistent look and feel for developers. The dark theme is based on Nord colors.

The philosophy of nano-emacs is to stick as much as possible to vanilla Emacs without introducing too much dependencies (or none if possible) and to keep it modular enough. The idea is for users to copy the part they are interested in such as to include them in their own configuration.

preview

Supported programming languages and formats

  • Bash
  • C++
  • Elisp
  • Golang
  • JSON
  • LaTeX
  • Makefile
  • Python
  • TOML
  • YAML

Limitations

  • Only dark theme is supported.
  • The configuration is tested mostly on Mac OS and rarely on Linux.

Mandatory requirements

  • GNU Emacs >= 30 with enabled tree-sitter. In case of Mac OS, emacs-plus is strongly recommended, e.g.:

    brew tap d12frosted/emacs-plus
brew install emacs-plus@30 \
  --with-imagemagick \
  --with-savchenkovaleriy-big-sur-icon \
  --with-xwidgets \
  --with-poll

  • Additional fonts

    brew install \
  homebrew/cask/font-roboto \
  homebrew/cask/font-roboto-slab \
  homebrew/cask/font-jetbrains-mono \
  homebrew/cask/font-jetbrains-mono-nerd-font

  • coreutls (Mac OS only) for better listing in Dired

    brew install coreutls

  • The fd utility (to search files with consult):

    brew install fd

Optional requirements

  • Clangd for LSP in C++.

  • Golangci-lint for linting in Golang.

  • Gopls for LSP in Golang.

  • Hunspell for spellchecking.

  • Markdownlint for markdown linting.

  • Pandoc for markdown preview.

  • Poetry for virtual environment management in Python

  • Pyright for LSP in Python.

  • LaTeX for formulas support in org mode, e.g.:

    brew install --cask mactex

Recommended Pyright setup

To provide automatic activation of virtual environments create pyrightconfig.json file in the root of your project with the following content:

{
  "venvPath": "<path-to-the-folder-containing-venv",
  "venv": "<name of the venv folder, e.g. .venv"
}

Common clipboard in Linux

To use common clipboard on Linux running under Wayland one needs to install wl-paste and wl-copy tools (recommended version >= 2.2), e.g.:

sudo apt-get install wl-clipboard

Installation

To install the project execute the following command:

make install