oatmealm / nano-emacs Goto Github PK

GNU Emacs / N Λ N O is a set of configuration files for GNU Emacs such as to provide a nice and consistent look and feel as shown below. It is based on design principles I described in the article "On the design of text Editors" that is available on arXiv. The light theme is based on Material colors and 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.

You need a recent version of GNU Emacs and to have the Roboto Mono and Fira Code fonts installed on your system. There are no other dependencies.

The easiest way to test nano emacs is to clone the directory on your desktop and to type (from inside the cloned repository):

$ emacs -q -l nano.el

If you like the result, you can merge the content of nano.el into your emacs configuration file. To do so, you'll need to modify the load-path to include the nano emacs repository and then call for the different modules. The only mandatory module is nano-faces that defines 6 faces that are used in other modules.

• nano-faces.el This module defines the fundamental faces of nano theme. If your Emacs has a theme or color-scheme, make sure its loaded before you load nano-faces so that its colors are used by nano.

• nano-theme-light.el or nano-theme-dark.el Theses modules define light and dark themes respectively by overriding the base colors. If your Emacs is not themed, you are encouraged to try one of these.

• nano-theme.el This module derives faces for several popular emacs modes from the nano faces. You can either use them all by calling (nano-theme), or pick what you want by calling your selection of (nano-theme-- functions.

• nano.el This module is mostly used to test nano emacs locally. Its content is supposed to be merged into an existing emacs configuration. See 'Quick test' section above.

• nano-help.el This module provides a function to display a small message in the echo area.

• nano-modeline.el This module defines a header line that is mode dependent and takes care of hiding the modeline when necessary.

• nano-layout.el This module defines the overall layout of an emacs frame, defining default font, fringes, margins, etc.

• nano-splash.el This module provides a splash screen when emacs is started.

• nano-colors.el This module provides a collection of colors palettes with function for easily accessing them.