branch: externals/nano-theme
commit a9e0dddf7ea001a92b6f3894cb775e1faeb29f33
Author: Nicolas P. Rougier <[email protected]>
Commit: Nicolas P. Rougier <[email protected]>
Added documentation
---
nano-theme.el | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
1 file changed, 53 insertions(+), 2 deletions(-)
diff --git a/nano-theme.el b/nano-theme.el
index a6ec684..ab6bd38 100644
--- a/nano-theme.el
+++ b/nano-theme.el
@@ -3,7 +3,7 @@
;; Copyright (C) 2021 Free Software Foundation, Inc.
;; Maintainer: Nicolas P. Rougier <[email protected]>
-;; URL: https://github.com/rougier/svg-lib
+;; URL: https://github.com/rougier/nano-theme
;; Version: 0.1
;; Package-Requires: ((emacs "27.1"))
;; Keywords: theme, dark, light
@@ -25,9 +25,60 @@
;;; Commentary:
;;
+;; N Λ N O theme is a consistent theme that comes in two flavors:
+;; - light theme is based on Material (https://material.io/)
+;; - the dark theme is based on Nord (https://www.nordtheme.com/).
+;;
+;; The theme is fully defined by a set of (1+6) faces as
+;; explained in this paper https://arxiv.org/abs/2008.06030:
+;;
+;; - Default face is the face for regular information.
+;;
+;; - Critical face is for information that requires immediate action.
+;;
+;; It should be of high constrast when compared to other
+;; faces. This can be realized (for example) by setting an intense
+;; background color, typically a shade of red. It must be used
+;; scarcely.
+;;
+;; - Popout face is used for information that needs attention.
+;;
+;; To achieve such effect, the hue of the face has to be
+;; sufficiently different from other faces such that it attracts
+;; attention through the popout effect.
+;;
+;; - Strong face is used for information of a structural nature.
+;;
+;; It has to be the same color as the default color and only the
+;; weight differs by one level (e.g., light/regular or
+;; regular/bold). IT is generally used for titles, keywords,
+;; directory, etc.
+;;
+;; - Salient face is used for information that are important.
+;;
+;; To suggest the information is of the same nature but important,
+;; the face uses a different hue with approximately the same
+;; intensity as the default face. This is typically used for
+;; links.
+
+;; - Faded face is for information that are less important.
+;;
+;; It is made by using the same hue as the default but with a
+;; lesser intensity than the default. It can be used for comments,
+;; secondary information and also replace italic (which is
+;; generally abused anyway
+;;
+;; - Subtle face is used to suggest a physical area on the screen.
+;;
+;; It is important to not disturb too strongly the reading of
+;; information and this can be made by setting a very light
+;; background color that is barely perceptible.
+;;
+;;
;; Usage example:
;;
-;; (nano-light) or (nano-dark)
+;; You can use the theme as a regular theme or you can
+;; (nano-light) / (nano-dark) to isntall the light or dark version.
;;
;; Optionally, you can use (nano-setup) to setup default settings.
;; Be careful since it will modify your configuration.
