DOT_EMACS

A pluggable and comprehensive configuration for Emacs that includes third-party libraries to create an all-in-one Emacs environment.

---

Contents

1. Overview
2. Supported Environments
3. Installation
4. Default Behavior
5. Versioning
6. Contribution
7. License

---

1. Overview

DOT_EMACS is designed to:

• Simplify the setup of a powerful Emacs environment with preconfigured settings.
• Include third-party libraries for enhanced functionality.
• Provide a modular and customizable structure for user preferences.

---

2. Supported Environments

DOT_EMACS is confirmed to work on:

• GNU Emacs on Debian/Ubuntu stable (from Debian 7 Wheezy with Emacs 23.4 to Debian 13 Trixie with Emacs 30.1).
• GNU Emacs on other Linux distributions within the same version range.
• Emacs for macOS (from emacsformacosx.com).
• Meadow based on Emacs 22.3.1 or later on Windows 7 (partial support, with limited functionality).

Supported Emacs versions:

• GNU Emacs 23.4 and later (up to and including 30.1, with future releases expected to be supported).

---

3. Installation

Run the install_dotemacs.sh script to install DOT_EMACS:

Usage:

# Install dot_emacs
#  $1 = emacs's binary path
#  $2 = installation target
#  $3 = nosudo

Default Installation:

~/dot_emacs/install_dotemacs.sh

This installs DOT_EMACS to the default location. Root privileges (via sudo) are required.

Custom Installation:

~/dot_emacs/install_dotemacs.sh /usr/bin/emacs ~/.emacs.d nosudo

This installs DOT_EMACS to ~/.emacs.d, bypassing the need for sudo.

Uninstallation:

~/dot_emacs/install_dotemacs.sh --uninstall

This removes the installed configuration from your system. You can also specify the Emacs binary and target path:

~/dot_emacs/install_dotemacs.sh --uninstall /usr/bin/emacs ~/.emacs.d nosudo

This allows you to uninstall from a custom location without using sudo.

---

4. Default Behavior

DOT_EMACS:

• Configures Emacs with preinstalled third-party libraries for enhanced functionality.
• Loads user-specific configurations from the ~/.emacs.d/elisp/ directory, including init.el and additional settings if available.

---

5. Versioning

DOT_EMACS uses the <year>.<month> versioning format starting from version 11.09. Example: 24.12

For detailed version history, please refer to the VERSIONS file.

---

6. Contribution

We welcome contributions! Here's how you can help:

1. Fork the repository.
2. Add or improve a feature, or fix an issue.
3. Submit a pull request with clear documentation and changes.

Please ensure your code is well-structured and documented.

For coding style and long-term Emacs Lisp compatibility policy, see the GUIDELINES document.

---

7. License

This repository is dual licensed under the GPL version 3 or the LGPL version 3, at your option. For full details, please refer to the LICENSE file. See also COPYING and COPYING.LESSER for the complete license texts.

Thank you for using and contributing to this repository!