aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorRichard Qin <richard.qin.x@gmail.com>2026-10-29 00:31:53 +0800
committerRichard Qin <richard.qin.x@gmail.com>2026-10-29 00:31:53 +0800
commited2abc29486a9f5f4a9b76949ca3012f24a9bf69 (patch)
tree614e16cd275e19084ee0feabc02531d8051f9086 /README
parentfcca130402a0f1a022904088240188dcf7068c0e (diff)
downloademacs.d-ed2abc29486a9f5f4a9b76949ca3012f24a9bf69.tar.gz
emacs.d-ed2abc29486a9f5f4a9b76949ca3012f24a9bf69.tar.xz
Add basic configurations
Signed-off-by: Richard Qin <richard.qin.x@gmail.com>
Diffstat (limited to 'README')
-rw-r--r--README45
1 files changed, 45 insertions, 0 deletions
diff --git a/README b/README
index e69de29..ba3ce9c 100644
--- a/README
+++ b/README
@@ -0,0 +1,45 @@
+GNU Emacs Configuration
+=======================
+
+Personal GNU Emacs configuration.
+
+Requirements
+------------
+
+GNU Emacs 29 or later
+Git
+
+Package Management
+------------------
+
+package.el
+use-package
+
+Package Archives
+----------------
+
+GNU ELPA
+NonGNU ELPA
+MELPA
+
+Directory Structure
+-------------------
+
+early-init.el Early initialization
+init.el Main configuration entry point
+lisp/ Configuration modules
+site-lisp/ Custom Emacs Lisp extensions
+snippets/ Code snippets
+templates/ File templates
+tests/ Configuration tests
+var/ Runtime data
+
+License
+-------
+
+Copyright (C) 2026 Richard Qin
+
+This configuration is distributed under the terms of the
+GNU General Public License, version 3 or later.
+
+See the COPYING file for details.