#+TITLE: gnome-dark-style.el
#+AUTHOR: David Dimagid
#+EMAIL: davidimagid@gmail.com
#+VERSION: 0.2.4
#+URL: https://github.com/dimagid/gnome-dark-style

* Description
The =gnome-dark-style= package automatically synchronizes the Emacs
theme with GNOME's color scheme. It allows users to define custom light
and dark themes, ensuring a consistent look and feel across the GNOME
desktop environment and GNU Emacs.

* Features
- Automatically switches between light and dark themes based on GNOME's
  color scheme.
- Supports custom light and dark themes.
- Monitors GNOME's color scheme in real-time and updates the Emacs theme
  accordingly.

* Requirements
- *GNOME Shell 47.4* (tested with this version).
- The =gsettings= command must be available on your system.

* Installation
** GNU ELPA package
The package is available as gnome-dark-style. Simply do:
   #+BEGIN_SRC elisp
     M-x package-refresh-contents
     M-x package-install
   #+END_SRC

** Manual installation
1. Clone the repository or download the =gnome-dark-style.el= file.
2. Add the following to your Emacs configuration file =init.el=:

   #+BEGIN_SRC elisp
   (add-to-list 'load-path "/path/to/gnome-dark-style")
   (require 'gnome-dark-style)
   #+END_SRC

3. Customize the light and dark themes using the =gnome-light-theme= and
   =gnome-dark-theme= variables.

* Configuration
You can customize the following variables:

- =gnome-light-theme=: The Emacs theme to use when GNOME's color scheme
  is set to light.
- =gnome-dark-theme=: The Emacs theme to use when GNOME's color scheme
  is set to dark.
- =gnome-dark-style-sync=: Enable or disable synchronization with
  GNOME's color scheme.

Example configuration with use-package:

#+BEGIN_SRC elisp
  ;; Sync Emacs theme with GNOME's color scheme
  (use-package gnome-dark-style
    ;; Uncomment and set your preferred themes
    ;; :custom
    ;; (gnome-light-theme 'ef-eagle)  ; default: nil
    ;; (gnome-dark-theme 'ef-owl)     ; default: wombat
    :config
    ;; Set to nil to stop monitoring and disable sync
    (setopt gnome-dark-style-sync t))
#+END_SRC

* Usage
Once installed and configured, the package will automatically switch
between the specified light and dark themes based on GNOME's color
scheme.

* License
This package is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.

* Contributing
Please send bug reports and suggestions by email to
[[mailto:davidimagid@gmail.com][davidimagid@gmail.com]].

You can also visit the [[https://github.com/dimagid/gnome-dark-style][GitHub repository]],
but email is the primary way to contribute and respects users'
freedom by not requiring non-free JavaScript.

* Acknowledgments
- Thanks to GNU and the FSF for their excellent communities, software and
  documentation.
