diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000000000000000000000000000000000000..7a4bc1e231cd555ac4775a1f5a74dccb4a03576d --- /dev/null +++ b/README.en.md @@ -0,0 +1,47 @@ +# Emacs Configuration + +This is a customized Emacs configuration repository designed for users who want to quickly set up an efficient Emacs working environment. + +## Features + +- Clean and efficient configuration approach +- Supports fast installation and initialization +- Includes commonly used plugins and key bindings + +## File Structure + +- `init.el`: Main configuration file, loaded when Emacs starts. +- `early-init.el`: Early initialization configuration file used to load settings ahead of time on Emacs 27+. +- `custom.el`: Custom settings typically generated by Emacs's customize functionality. +- The `lisp/` directory contains multiple initialization files, each configuring a distinct functional module: + - `init-config.el`: General configuration. + - `init-keybindings.el`: Key binding configuration. + - `init-packages.el`: Package management configuration. + +## Installation + +1. Clone this repository locally: + + ```bash + git clone https://gitee.com/unchg/emacs.git + ``` + +2. Copy the configuration files into Emacs's configuration directory (typically `~/.emacs.d/`): + + ```bash + cp -r emacs/* ~/.emacs.d/ + ``` + +3. Start Emacs; the configuration will take effect automatically. + +## Usage + +Simply start Emacs to automatically load all configurations. You can modify the configuration files in `init.el` and the `lisp/` directory to suit your personal preferences. + +## Contribution + +Pull requests to improve or extend the configuration are welcome. Please ensure your changes are clear, well-documented, and follow the project's coding style. + +## License + +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..c7d0c3cd09149f23f8ec2de67d7f2d8b517c39b7 --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ +# Emacs 配置 + +这是一个 Emacs 的定制配置仓库,适用于希望快速搭建高效 Emacs 工作环境的用户。 + +## 特性 + +- 简洁高效的配置方式 +- 支持快速安装和初始化 +- 包含常用插件和快捷键绑定 + +## 文件结构 + +- `init.el`:主配置文件,Emacs 启动时会加载此文件。 +- `early-init.el`:早期初始化配置文件,用于在 Emacs 27+ 上提前加载配置。 +- `custom.el`:自定义设置,通常由 Emacs 的 customize 功能生成。 +- `lisp/` 目录下包含多个初始化文件,分别用于配置不同的功能模块: + - `init-config.el`:通用配置。 + - `init-keybindings.el`:快捷键绑定配置。 + - `init-packages.el`:插件包管理配置。 + +## 安装 + +1. 克隆本仓库到本地: + + ```bash + git clone https://gitee.com/unchg/emacs.git + ``` + +2. 将配置文件放置在 Emacs 的配置目录中(通常是 `~/.emacs.d/`): + + ```bash + cp -r emacs/* ~/.emacs.d/ + ``` + +3. 启动 Emacs,配置将自动生效。 + +## 使用 + +启动 Emacs 即可自动加载所有配置。你可以根据需要修改 `init.el` 和 `lisp/` 目录下的配置文件以适应个人习惯。 + +## 贡献 + +欢迎提交 Pull Request 来改进或扩展配置。请确保你的改动清晰、有文档说明,并遵循项目的编码风格。 + +## 许可证 + +本项目遵循 MIT 许可证。详情请查看 [LICENSE](LICENSE) 文件。 \ No newline at end of file