diff --git a/README.org b/README.org index 3017511..4b665fb 100644 --- a/README.org +++ b/README.org @@ -14,6 +14,26 @@ They also correspond to four stages of the day, with future intent being to tran | Leucosis | White | Mid-day | Opal | | Iosis | Red/Purple | Dusk | Sunset | +* Installation +The four theme files in this repository can be copied to your emacs user directory, where emacs will recognise them on startup. + +Alternatively, the following snippet can be used to install the themes via Straight. +#+begin_src elisp + ;; Load package through straight + (straight-use-package + '(ouroboros-emacs-themes :type git + :host nil + :repo "https://git.cyan.sh/BirDt/ouroboros-emacs-themes.git" + :files ("*.el"))) + + ;; Add build dir to custom theme load path + (add-to-list 'custom-theme-load-path + (expand-file-name (concat "straight/" straight-build-dir "/ouroboros-emacs-themes/") user-emacs-directory)) + + ;; Load melanosis + (load-theme 'melanosis t) +#+end_src + * Supported Packages Ouroboros aims to support the following additional Emacs packages natively with every theme: - Treemacs